├── docs ├── Managing-ROMs.md ├── Commodore-64.md ├── images │ ├── logo.png │ ├── cannonball │ │ └── logo.png │ ├── shaders │ │ ├── 9cbhrVu.png │ │ ├── 9cnVeTC.jpg │ │ ├── I9X0SJr.jpg │ │ ├── KnUBAMu.jpg │ │ ├── TuZvVXe.jpg │ │ ├── WOQXb1z.jpg │ │ ├── fXHP7Ac.png │ │ ├── oL7BOvk.jpg │ │ ├── xsLAmVk.jpg │ │ ├── 6168494768_7cc6296f43_b.jpg │ │ ├── 1478613483800-upload-9a6df26e-794d-42b0-a0af-feeb176b488f.png │ │ ├── 1478902457187-upload-4c1d9b59-a473-43d3-9a56-cc50506ef690.png │ │ └── 1478613018469-upload-514e190e-162d-4917-b32d-a9e584094039-resized.png │ ├── emulators │ │ ├── AqxfVpy.png │ │ └── QSPlNYP.png │ ├── es-themes │ │ ├── 0wmJRci.jpg │ │ ├── 1C0WpSY.jpg │ │ ├── 72DcwpD.jpg │ │ ├── 7rTdbH0.jpg │ │ ├── 8SDAVnh.jpg │ │ ├── 9Y6TJVb.jpg │ │ ├── 9yxamrj.jpg │ │ ├── AE3ekgG.jpg │ │ ├── AEvEJlx.jpg │ │ ├── AP9MMrP.jpg │ │ ├── BkmG3Ql.jpg │ │ ├── BlJ48ai.jpg │ │ ├── HAGiZFs.jpg │ │ ├── NSqdR7J.jpg │ │ ├── UPjyJwH.jpg │ │ ├── cK7SobG.jpg │ │ ├── ds7R8Ho.jpg │ │ ├── eCn9Zdf.jpg │ │ ├── h2uuxB8.jpg │ │ ├── l79clQi.jpg │ │ ├── lAdXXMF.jpg │ │ ├── lSIjOyk.jpg │ │ ├── lVv0QRa.jpg │ │ ├── mNzCWPS.jpg │ │ ├── pAQ9pTf.jpg │ │ ├── pSHuOXK.jpg │ │ ├── r5SHwkc.jpg │ │ ├── uTBYI4V.jpg │ │ ├── th_01_epnoir_asis.png │ │ ├── th_02_epnoir_size_x_0.png │ │ ├── th_03_epnoir_size_x_gt_0_y_eq_0.png │ │ ├── th_04_epnoir_size_x_gt_0_y_lt_onelineheight.png │ │ └── th_05_epnoir_size_x_gt_0_y_gt_onelineheight.png │ ├── controllers │ │ ├── 2z6Kq9E.png │ │ ├── KN6TgtP.png │ │ ├── YgFJL00.jpg │ │ ├── cUnEP0O.jpg │ │ └── r1ux66d.jpg │ ├── scraper │ │ ├── es_scraper_1.png │ │ ├── es_scraper_2.png │ │ ├── es_scraper_3.png │ │ ├── es_scraper_4.png │ │ ├── es_scraper_5.png │ │ ├── scraped_game.png │ │ ├── skyscraper_1.png │ │ ├── skyscraper_cover.png │ │ ├── skyscraper_shot.png │ │ ├── skyscraper_wheel.png │ │ ├── sselph_scraper_1.png │ │ ├── sselph_scraper_2.png │ │ └── skyscraper_artwork.png │ ├── wifi │ │ ├── wifi4_connected.png │ │ ├── wifi1_connect_menuitem.png │ │ ├── ES_RetroPie_Config_WiFi.png │ │ ├── wifi2_select_wireless_nw.png │ │ ├── wifi_import_wifikeyfile.png │ │ └── wifi3_osk_wireless_password.png │ ├── wolfenstein-3d │ │ └── wolf3d.png │ ├── runcommand │ │ ├── runcommand-menu.png │ │ ├── runcommand-config.png │ │ ├── runcommand-emulator.png │ │ └── runcommand-splash.png │ └── first-installation │ │ └── First-Installation--Emulationstation.png ├── Lincity.md ├── Mobile-Gamepad.md ├── Giana's-Return.md ├── Micropolis.md ├── The-Ur-Quan-Masters.md ├── VPN.md ├── ResidualVM.md ├── Touchscreen.md ├── Solarus.md ├── Dinothawr.md ├── Marathon.md ├── N64-Controller.md ├── SuperTux.md ├── Xrick.md ├── Dragon.md ├── Multiplayer-Saves-&-Unlockables.md ├── GameCube.md ├── WonderSwan.md ├── WonderSwan-Color.md ├── Playstation-2.md ├── SG-1000.md ├── Coco.md ├── Gamepad-G910-bluetooth-controler.md ├── ZX81.md ├── Vectrex.md ├── Minecraft.md ├── Pokemon-Mini.md ├── Atari-7800.md ├── TI-99.md ├── Atari-Jaguar.md ├── Sharp-X1.md ├── Nintendo-Switch-Controllers.md ├── Atari-Lynx.md ├── Oric.md ├── Game-&-Watch.md ├── Zmachine.md ├── TRS-80.md ├── Xiaomi-Controller.md ├── Cave-Story.md ├── stylesheets │ └── extra.css ├── Sega-32X.md ├── OpenBOR.md ├── Atari-2600.md ├── CHD-files.md ├── Wii-U-Pro-Controller.md ├── Configuration-Editor.md ├── Wii.md ├── Virtual-Boy.md ├── OpenTTD.md ├── GemRB.md ├── Cannonball.md ├── Neo-Geo-Pocket.md ├── PC-FX.md ├── OpenTyrian.md ├── Neo-Geo-Pocket-Color.md ├── Video-Issues.md ├── Sharp-X68000.md ├── Game-Boy-Color.md ├── index.md ├── Adventure-Game-Studio.md ├── RetroArch-Core-Options.md ├── Apple-II.md ├── Famicom-Disk-System.md ├── 3do.md ├── PSP-FuSa-gamepad.md ├── Macintosh.md ├── Game-Gear.md ├── Colecovision.md ├── Love.md ├── SDLPoP.md ├── Memory-Split.md ├── PSP.md ├── Netplay.md ├── Master-System.md ├── Fairchild-ChannelF.md ├── Nintendo-DS.md ├── VideoPac-Odyssey-2.md ├── Duke-Nukem-3D.md ├── Descent.md ├── Cheats.md ├── Transferring-Roms.md ├── Smaller-RetroArch-Screen.md ├── Controller-Configuration.md ├── Virtual-Gamepad.md ├── ScummVM.md ├── MESS.md ├── Thomson-MOTO.md ├── PC-9800.md ├── Sam-Coupe.md ├── ZX-Spectrum.md └── Saturn.md ├── README.md └── .gitmodules /docs/Managing-ROMs.md: -------------------------------------------------------------------------------- 1 | ## PAGE MOVED! 2 | 3 | [Arcade](Arcade) -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # docs 2 | Github wiki to mkdocs hosted on github pages 3 | -------------------------------------------------------------------------------- /docs/Commodore-64.md: -------------------------------------------------------------------------------- 1 | See [Commodore 64, VIC-20, PET](Commodore-64-VIC-20-PET) -------------------------------------------------------------------------------- /docs/images/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/logo.png -------------------------------------------------------------------------------- /docs/images/cannonball/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/cannonball/logo.png -------------------------------------------------------------------------------- /docs/images/shaders/9cbhrVu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/shaders/9cbhrVu.png -------------------------------------------------------------------------------- /docs/images/shaders/9cnVeTC.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/shaders/9cnVeTC.jpg -------------------------------------------------------------------------------- /docs/images/shaders/I9X0SJr.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/shaders/I9X0SJr.jpg -------------------------------------------------------------------------------- /docs/images/shaders/KnUBAMu.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/shaders/KnUBAMu.jpg -------------------------------------------------------------------------------- /docs/images/shaders/TuZvVXe.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/shaders/TuZvVXe.jpg -------------------------------------------------------------------------------- /docs/images/shaders/WOQXb1z.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/shaders/WOQXb1z.jpg -------------------------------------------------------------------------------- /docs/images/shaders/fXHP7Ac.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/shaders/fXHP7Ac.png -------------------------------------------------------------------------------- /docs/images/shaders/oL7BOvk.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/shaders/oL7BOvk.jpg -------------------------------------------------------------------------------- /docs/images/shaders/xsLAmVk.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/shaders/xsLAmVk.jpg -------------------------------------------------------------------------------- /docs/images/emulators/AqxfVpy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/emulators/AqxfVpy.png -------------------------------------------------------------------------------- /docs/images/emulators/QSPlNYP.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/emulators/QSPlNYP.png -------------------------------------------------------------------------------- /docs/images/es-themes/0wmJRci.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/0wmJRci.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/1C0WpSY.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/1C0WpSY.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/72DcwpD.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/72DcwpD.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/7rTdbH0.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/7rTdbH0.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/8SDAVnh.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/8SDAVnh.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/9Y6TJVb.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/9Y6TJVb.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/9yxamrj.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/9yxamrj.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/AE3ekgG.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/AE3ekgG.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/AEvEJlx.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/AEvEJlx.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/AP9MMrP.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/AP9MMrP.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/BkmG3Ql.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/BkmG3Ql.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/BlJ48ai.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/BlJ48ai.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/HAGiZFs.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/HAGiZFs.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/NSqdR7J.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/NSqdR7J.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/UPjyJwH.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/UPjyJwH.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/cK7SobG.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/cK7SobG.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/ds7R8Ho.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/ds7R8Ho.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/eCn9Zdf.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/eCn9Zdf.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/h2uuxB8.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/h2uuxB8.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/l79clQi.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/l79clQi.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/lAdXXMF.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/lAdXXMF.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/lSIjOyk.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/lSIjOyk.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/lVv0QRa.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/lVv0QRa.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/mNzCWPS.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/mNzCWPS.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/pAQ9pTf.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/pAQ9pTf.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/pSHuOXK.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/pSHuOXK.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/r5SHwkc.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/r5SHwkc.jpg -------------------------------------------------------------------------------- /docs/images/es-themes/uTBYI4V.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/uTBYI4V.jpg -------------------------------------------------------------------------------- /docs/images/controllers/2z6Kq9E.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/controllers/2z6Kq9E.png -------------------------------------------------------------------------------- /docs/images/controllers/KN6TgtP.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/controllers/KN6TgtP.png -------------------------------------------------------------------------------- /docs/images/controllers/YgFJL00.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/controllers/YgFJL00.jpg -------------------------------------------------------------------------------- /docs/images/controllers/cUnEP0O.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/controllers/cUnEP0O.jpg -------------------------------------------------------------------------------- /docs/images/controllers/r1ux66d.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/controllers/r1ux66d.jpg -------------------------------------------------------------------------------- /docs/images/scraper/es_scraper_1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/scraper/es_scraper_1.png -------------------------------------------------------------------------------- /docs/images/scraper/es_scraper_2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/scraper/es_scraper_2.png -------------------------------------------------------------------------------- /docs/images/scraper/es_scraper_3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/scraper/es_scraper_3.png -------------------------------------------------------------------------------- /docs/images/scraper/es_scraper_4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/scraper/es_scraper_4.png -------------------------------------------------------------------------------- /docs/images/scraper/es_scraper_5.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/scraper/es_scraper_5.png -------------------------------------------------------------------------------- /docs/images/scraper/scraped_game.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/scraper/scraped_game.png -------------------------------------------------------------------------------- /docs/images/scraper/skyscraper_1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/scraper/skyscraper_1.png -------------------------------------------------------------------------------- /docs/images/wifi/wifi4_connected.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/wifi/wifi4_connected.png -------------------------------------------------------------------------------- /docs/images/wolfenstein-3d/wolf3d.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/wolfenstein-3d/wolf3d.png -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "retropie.wiki"] 2 | path = retropie.wiki 3 | url = https://github.com/RetroPie/RetroPie-Setup.wiki.git 4 | -------------------------------------------------------------------------------- /docs/images/scraper/skyscraper_cover.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/scraper/skyscraper_cover.png -------------------------------------------------------------------------------- /docs/images/scraper/skyscraper_shot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/scraper/skyscraper_shot.png -------------------------------------------------------------------------------- /docs/images/scraper/skyscraper_wheel.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/scraper/skyscraper_wheel.png -------------------------------------------------------------------------------- /docs/images/scraper/sselph_scraper_1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/scraper/sselph_scraper_1.png -------------------------------------------------------------------------------- /docs/images/scraper/sselph_scraper_2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/scraper/sselph_scraper_2.png -------------------------------------------------------------------------------- /docs/images/es-themes/th_01_epnoir_asis.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/th_01_epnoir_asis.png -------------------------------------------------------------------------------- /docs/images/runcommand/runcommand-menu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/runcommand/runcommand-menu.png -------------------------------------------------------------------------------- /docs/images/scraper/skyscraper_artwork.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/scraper/skyscraper_artwork.png -------------------------------------------------------------------------------- /docs/images/wifi/wifi1_connect_menuitem.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/wifi/wifi1_connect_menuitem.png -------------------------------------------------------------------------------- /docs/images/runcommand/runcommand-config.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/runcommand/runcommand-config.png -------------------------------------------------------------------------------- /docs/images/runcommand/runcommand-emulator.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/runcommand/runcommand-emulator.png -------------------------------------------------------------------------------- /docs/images/runcommand/runcommand-splash.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/runcommand/runcommand-splash.png -------------------------------------------------------------------------------- /docs/images/wifi/ES_RetroPie_Config_WiFi.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/wifi/ES_RetroPie_Config_WiFi.png -------------------------------------------------------------------------------- /docs/images/wifi/wifi2_select_wireless_nw.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/wifi/wifi2_select_wireless_nw.png -------------------------------------------------------------------------------- /docs/images/wifi/wifi_import_wifikeyfile.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/wifi/wifi_import_wifikeyfile.png -------------------------------------------------------------------------------- /docs/images/es-themes/th_02_epnoir_size_x_0.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/th_02_epnoir_size_x_0.png -------------------------------------------------------------------------------- /docs/images/shaders/6168494768_7cc6296f43_b.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/shaders/6168494768_7cc6296f43_b.jpg -------------------------------------------------------------------------------- /docs/images/wifi/wifi3_osk_wireless_password.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/wifi/wifi3_osk_wireless_password.png -------------------------------------------------------------------------------- /docs/images/es-themes/th_03_epnoir_size_x_gt_0_y_eq_0.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/th_03_epnoir_size_x_gt_0_y_eq_0.png -------------------------------------------------------------------------------- /docs/images/es-themes/th_04_epnoir_size_x_gt_0_y_lt_onelineheight.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/th_04_epnoir_size_x_gt_0_y_lt_onelineheight.png -------------------------------------------------------------------------------- /docs/images/es-themes/th_05_epnoir_size_x_gt_0_y_gt_onelineheight.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/es-themes/th_05_epnoir_size_x_gt_0_y_gt_onelineheight.png -------------------------------------------------------------------------------- /docs/images/first-installation/First-Installation--Emulationstation.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/first-installation/First-Installation--Emulationstation.png -------------------------------------------------------------------------------- /docs/images/shaders/1478613483800-upload-9a6df26e-794d-42b0-a0af-feeb176b488f.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/shaders/1478613483800-upload-9a6df26e-794d-42b0-a0af-feeb176b488f.png -------------------------------------------------------------------------------- /docs/images/shaders/1478902457187-upload-4c1d9b59-a473-43d3-9a56-cc50506ef690.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/shaders/1478902457187-upload-4c1d9b59-a473-43d3-9a56-cc50506ef690.png -------------------------------------------------------------------------------- /docs/images/shaders/1478613018469-upload-514e190e-162d-4917-b32d-a9e584094039-resized.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HerbFargus/docs/HEAD/docs/images/shaders/1478613018469-upload-514e190e-162d-4917-b32d-a9e584094039-resized.png -------------------------------------------------------------------------------- /docs/Lincity.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![](http://lincity.sourceforge.net/screenshots/power.png) 3 | *** 4 | _Lincity is yet another Sim City clone._ 5 | *** 6 | 7 | ## Port: [Lincity](http://lincity.sourceforge.net/) 8 | 9 | ## Controls: 10 | 11 | Keyboard and Mouse -------------------------------------------------------------------------------- /docs/Mobile-Gamepad.md: -------------------------------------------------------------------------------- 1 | Mobile Universal Gamepad for RetroPie 2 | ![MobileGamepad](https://github.com/sbidolach/mobile-gamepad/blob/master/other/resources/schema_mobilegamepad.png?raw=true) 3 | *** 4 | _Full description about project is available on page. https://github.com/sbidolach/mobile-gamepad_ 5 | *** 6 | -------------------------------------------------------------------------------- /docs/Giana's-Return.md: -------------------------------------------------------------------------------- 1 | 2 | *** 3 | 4 | ![](http://www.gianas-return.de/wp-content/themes/gianasreturn-winter/logo.gif) 5 | 6 | *** 7 | _Giana's Return is a fanmade sequel to the Giana Sisters._ 8 | *** 9 | ## Emulator: [Giana's Return](http://www.gianas-return.de/) 10 | 11 | ## Controls: 12 | 13 | Keyboard 14 | -------------------------------------------------------------------------------- /docs/Micropolis.md: -------------------------------------------------------------------------------- 1 | 2 | *** 3 | 4 | ![](https://community.linuxmint.com/img/screenshots/micropolis.png) 5 | 6 | *** 7 | _Micropolis is essentially an open source version of the game Sim City._ 8 | 9 | *** 10 | ## Emulator: [Micropolis](http://www.donhopkins.com/home/micropolis/) 11 | 12 | ## Controls: 13 | 14 | Mouse and Keyboard -------------------------------------------------------------------------------- /docs/The-Ur-Quan-Masters.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![](http://media.moddb.com/images/articles/1/99/98798/urquan.png) 3 | *** 4 | _The Ur Quan Masters is a port of Star Control II_ 5 | *** 6 | 7 | ## Emulator: [UQM](http://wiki.uqm.stack.nl/Main_Page) (EXPERIMENTAL) 8 | 9 | ## ROMS 10 | 11 | Game Data is provided by the setup script 12 | 13 | ## Controls 14 | 15 | Mouse and Keyboard 16 | 17 | -------------------------------------------------------------------------------- /docs/VPN.md: -------------------------------------------------------------------------------- 1 | This guide uses NordVPN as an example though there are many other VPN Providers. 2 | 3 | ### Install Dependencies 4 | 5 | ``` 6 | sudo apt update 7 | sudo apt install openvpn unzip 8 | ``` 9 | 10 | ### Install NordVPN server configs 11 | 12 | ``` 13 | cd /etc/openvpn/ 14 | sudo wget https://nordvpn.com/api/files/zip 15 | sudo unzip zip 16 | ``` 17 | 18 | ### Connect to VPN 19 | 20 | `sudo openvpn file_name` (for example: sudo openvpn de75.nordvpn.com.udp1194.ovpn) 21 | 22 | To Kill Process: `Ctrl+C` or `sudo killall openvpn` 23 | 24 | ### Start VPN at Boot 25 | 26 | TODO -------------------------------------------------------------------------------- /docs/ResidualVM.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![](http://jenni.wdfiles.com/local--files/grim-fandango/residualvm_logo.png) 3 | *** 4 | _ResidualVM was a game engine for the games Grim Fandango, Escape From Monkey Island, and Myst III: Exile._ 5 | *** 6 | 7 | ## Emulator: [ResidualVM](https://github.com/residualvm/residualvm) (REMOVED Oct 2025, Experimental) 8 | 9 | Initially a fork of [ScummVM](ScummVM) to allow playing the 3 games supported, it has been merged back to the parent project in 2021 and the games are playable in [ScummVM](ScummVM). 10 | 11 | The emulator has been **removed** from RetroPie, use [ScummVM](ScummVM) instead. 12 | -------------------------------------------------------------------------------- /docs/Touchscreen.md: -------------------------------------------------------------------------------- 1 | 1: Open Retroarch in the Retropie section of Emulation Station 2 | 3 | 2: Open input (in the settings menu) and select User 1 binds. 4 | 5 | 3: Set the mouse index to 2 6 | 7 | 4: Go back to the settings menu and select Configuration File 8 | 9 | 5: Select Save configuration file 10 | 11 | 6: Exit retroarch and enjoy 12 | 13 | The touchscreen only works in games that allow mice input. See the retropie docs on trackpads for more info on how to setup a mouse in emulators 14 | 15 | Troubleshooting: 16 | The touchscreen is not responding 17 | Change the mouse index one digit higher, if it still isn’t working keep going up. (you can also try 1) 18 | -------------------------------------------------------------------------------- /docs/Solarus.md: -------------------------------------------------------------------------------- 1 | ![](https://gitlab.com/solarus-games/solarus-design/-/raw/master/emulationstation_art/carbon/theme/art/system.svg) 2 | 3 | 4 | _Solarus is a game engine for Zeldaesque games._ 5 | 6 | Emulator: [Solarus](http://www.solarus-games.org/) (EXPERIMENTAL) 7 | 8 | ## ROMS 9 | 10 | Games are already added through the script though extra games can be added manually. 11 | 12 | ## Controls: 13 | 14 | Keyboard and Mouse 15 | 16 | ## Configuration 17 | 18 | Specify 640X480 video resolution in the [Runcommand Menu](Runcommand) to get it to fill your screen instead of sitting at the bottom left corner of your screen. 19 | Or press F11 after launching a Solarus game, it will switch to fullscreen mode and the setting will be saved. -------------------------------------------------------------------------------- /docs/Dinothawr.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![Dinothawr Logo](https://raw.githubusercontent.com/Themaister/Dinothawr/master/dinothawr/assets/titlescreen.png) 3 | *** 4 | Dinothawr is a block pushing puzzle game on slippery surfaces. Our hero is a dinosaur whose friends are trapped in ice. Through puzzles it is your task to free the dinos from their ice prison. 5 | *** 6 | ## Emulator: [libretro-dinothawr](https://github.com/libretro/Dinothawr) 7 | 8 | ## Controls 9 | 10 | libretro-dinothawr utilises Retroarch configurations 11 | 12 | Add custom retroarch controls to the retroarch.cfg file in 13 | ```shell 14 | /opt/retropie/configs/dinothawr/retroarch.cfg 15 | ``` 16 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) 17 | -------------------------------------------------------------------------------- /docs/Marathon.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![](https://alephone.lhowon.org/images/marathon_title.png) 3 | 4 | *** 5 | _Marathon is a first-person shooter video game developed and published by Bungie, and released in December 1994 for the Apple Macintosh._ 6 | 7 | *** 8 | 9 | ## Emulator: [Aleph One](https://alephone.lhowon.org/) 10 | 11 | 12 | ## ROMS: 13 | 14 | Games are downloaded with the script. 15 | 16 | To get the games running, make sure to set each game to use the software renderer and disable the enhanced HUD from the Plugins section of the Environment menu. For Marathon 1, disable both HUDs from the Plugins menu, start a game, quit back to the title screen and enable Enhanced HUD and it will work and properly. 17 | 18 | ## Controls: 19 | 20 | Keyboard, mouse and joystick all supported. -------------------------------------------------------------------------------- /docs/N64-Controller.md: -------------------------------------------------------------------------------- 1 | From [here](http://blog.petrockblock.com/2012/10/21/the-retropie-gpio-adapter/#comment-841277725): 2 | 3 | I recently started messing with it again and used an n64 controller instead. not only does it have more buttons, it also has less to connect, just + at pin 1 and at 6, and data at pin 7. as long as you put in 4 | 5 | ```shell 6 | gamecon_gpio_rpi map=0,0,6,0 7 | ``` 8 | 9 | in 10 | 11 | ```shell 12 | /etc/modules 13 | ``` 14 | 15 | It starts right up on boot. You also need to then run 16 | 17 | ```shell 18 | cd ~/RetroPie/emulators/RetroArch/tools 19 | ./retroarch-joyconfig 20 | ``` 21 | 22 | Then save the output to your Retropie config file (this is a lot easier if you do it by ssh, with copy paste into vi/nano) to: 23 | 24 | ```shell 25 | ~/RetroPie/configs/all/retroarch.cfg 26 | ``` 27 | -------------------------------------------------------------------------------- /docs/SuperTux.md: -------------------------------------------------------------------------------- 1 | ![](http://supertux.lethargik.org/wiki/images/c/c9/Logo.png) 2 | 3 | *** 4 | SuperTux is a 2d sidescrolling platformer with marioesque tones of gameplay. It features the Linux mascot Tux the penguin. 5 | 6 | *** 7 | This emulator is experimental and can be installed from the experimental menu of the [retropie setup script](Updating-RetroPie) 8 | 9 | ### Controls 10 | |Control| Default mapping| Description| 11 | | :---: | :---: | :--- | 12 | |Left |Cursor Left |Makes Tux walk left| 13 | |Right |Cursor Right |Makes Tux walk right| 14 | |Up |Cursor Up |Enter door, activate switch| 15 | |Down |Cursor Down |Duck| 16 | |Jump |Spacebar |Makes Tux jump. Hold down longer to jump higher.| 17 | |Action |Left Control |Varies| 18 | 19 | For more information visit the official documentation [**HERE**](http://supertux.lethargik.org/wiki/User_Manual) -------------------------------------------------------------------------------- /docs/Xrick.md: -------------------------------------------------------------------------------- 1 | ![](http://www.rickdangerous.co.uk/rdtitle.png) 2 | *** 3 | _lr-xrick_ is a port of _Rick Dangerous_. 4 | 5 | Way before Lara Croft, back in the 1980's and early 1990's, Rick Dangerous was the Indiana Jones of computer games, running away from rolling rocks, avoiding traps, from South America to a futuristic missile base via Egypt and the Schwarzendumpf castle. 6 | 7 | *** 8 | 9 | ## Port: [Xrick-libretro](https://github.com/libretro/xrick-libretro) 10 | 11 | It can be installed from the experimental section of the packages. 12 | 13 | The game data is not provided with the port, it is necessary to download the _data.zip_ file from 14 | , then copy it to `/home/pi/RetroPie/roms/ports/xrick/`. Start _Xrick_ from the Ports system. 15 | 16 | ## Controls 17 | Uses libretro controls - keyboard/gamepads are supported. 18 | 19 | -------------------------------------------------------------------------------- /docs/Dragon.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![dragon32](https://cloud.githubusercontent.com/assets/10035308/12191211/24642b98-b58f-11e5-83aa-34ab38abc78c.png) 3 | *** 4 | _The Dragon 32 and Dragon 64 were home computers originally released in 1980. The 32 and 64 refer to the kilobytes of RAM._ 5 | 6 | *** 7 | 8 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 9 | | :---: | :---: | :---: | :---: | :---: | 10 | | [XRoar](http://www.6809.org.uk/xroar/) | dragon32 | .bin .cas .wav .bas .asc .dmk .jvc .os9 .dsk .vdk .rom .ccc .sna | d32.rom | hardcoded | 11 | 12 | ## Emulator: [XRoar](http://www.6809.org.uk/xroar/) 13 | 14 | ## ROMS 15 | Accepted File Extensions: **.cas .wav .bas .asc .dmk .jvc .os9 .dsk .vdk .rom .ccc .sna** 16 | 17 | Place your Dragon ROMs in 18 | ``` 19 | /home/pi/RetroPie/roms/dragon32 20 | ``` 21 | ## BIOS 22 | 23 | The file needed is **d32.rom** 24 | 25 | Place your d32.rom BIOS file in 26 | ``` 27 | /home/pi/RetroPie/BIOS 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/Multiplayer-Saves-&-Unlockables.md: -------------------------------------------------------------------------------- 1 | Want to play a local multiplayer game but don't want to unlock all the levels, characters, etc.? 2 | 3 | Want to play as Tofu in Resident Evil 2? 4 | 5 | Want to play as Ness vs Captain Falcon vs Luigi vs Jigglypuff on Mushroom Kingdom in Super Smash Bros. (N64) without spending countless hours unlocking EVERYTHING? 6 | 7 | [You can download these pre-made game saves so you can experience the full local multiplayer/retro experience! ](https://github.com/madmodder123/retropie_saves) 8 | 9 | I went through the headache of using cheats or finding save games on the internet and started this Github page for people to obtain them from. 10 | Most of the saves are for RetroArch emulators but there are also saves for other emulators. 11 | 12 | You just need to throw the saves in your "roms" folder and make sure the games are named the same as your ROMs or the saves won't load. 13 | 14 | Please contribute if you have any saves that are missing. 15 | 16 | -------------------------------------------------------------------------------- /docs/GameCube.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![gc](https://cloud.githubusercontent.com/assets/10035308/18609175/be037df8-7cb8-11e6-918b-a57a12ebb601.png) 3 | *** 4 | _The GameCube is a home video game console that was released by Nintendo on September 14, 2001._ 5 | *** 6 | 7 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 8 | | :---: | :---: | :---: | :---: | :---: | 9 | | [dolphin](https://github.com/dolphin-emu/dolphin.git) | gc | .ciso .gcm .gcz .iso .rvz .m3u | none | /opt/retropie/configs/gc/Config | 10 | | [lr-dolphin](https://github.com/dolphin-emu/dolphin.git) | gc | .ciso .gcm .gcz .iso .rvz .m3u | none | /opt/retropie/configs/gc/retroarch.cfg | 11 | 12 | **Note**: This is mainly for x86_64 builds - Raspberry Pi models are pretty weak to be able emulate a GameCube, a Pi5 or later is needed. 13 | 14 | ## Emulator: [Dolphin](https://github.com/dolphin-emu/dolphin.git) 15 | 16 | ## ROMS 17 | 18 | Accepted File Extensions: *.ciso .gcm .gcz .iso .rvz .m3u* 19 | 20 | Place your GameCube games in 21 | ``` 22 | /home/pi/RetroPie/roms/gc 23 | ``` 24 | ## Controls 25 | 26 | See [Wii Controls](Wii#controls) 27 | -------------------------------------------------------------------------------- /docs/WonderSwan.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![wonderswan](https://cloud.githubusercontent.com/assets/10035308/12212916/3dc08dc2-b62d-11e5-9b9b-6b547fa3b80d.png) 3 | *** 4 | 5 | WonderSwan is a handheld gaming device that was released by Bandai solely in Japan in 1998. 6 | *** 7 | 8 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 9 | | :---: | :---: | :---: | :---: | :---: | 10 | | [lr-beetle-wswan](https://github.com/libretro/beetle-wswan-libretro.git) | wonderswan | .7z .ws .zip | none | /opt/retropie/configs/wonderswan/retroarch.cfg | 11 | 12 | ## Emulator: [lr-beetle-wswan](https://github.com/libretro/beetle-wswan-libretro.git) 13 | 14 | ## ROMS 15 | 16 | Accepted File Extensions **.7z .ws .zip** 17 | 18 | Place your WonderSwan ROMs in 19 | ``` 20 | /home/pi/RetroPie/roms/wonderswan 21 | ``` 22 | 23 | ## Controls 24 | 25 | lr-beetle-wswan utilises Retroarch configurations 26 | 27 | Add custom retroarch controls to the retroarch.cfg file in 28 | ```shell 29 | /opt/retropie/configs/wonderswan/retroarch.cfg 30 | ``` 31 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) -------------------------------------------------------------------------------- /docs/WonderSwan-Color.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![wonderswancolor](https://cloud.githubusercontent.com/assets/10035308/12214039/17943b4c-b643-11e5-9bb7-82320217d7a9.png) 3 | *** 4 | 5 | WonderSwan Color is a handheld gaming device that was released by Bandai in 2000. 6 | *** 7 | 8 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 9 | | :---: | :---: | :---: | :---: | :---: | 10 | | [lr-beetle-wswan](https://github.com/libretro/beetle-wswan-libretro.git) | wonderswancolor | .7z .wsc .zip | none | /opt/retropie/configs/wonderswancolor/retroarch.cfg | 11 | 12 | ## Emulator: [lr-beetle-wswan](https://github.com/libretro/beetle-wswan-libretro.git) 13 | 14 | ## ROMS 15 | 16 | Accepted File Extensions **.7z .wsc .zip** 17 | 18 | Place your WonderSwan Color ROMs in 19 | ``` 20 | /home/pi/RetroPie/roms/wonderswancolor 21 | ``` 22 | 23 | ## Controls 24 | 25 | lr-beetle-wswan utilises Retroarch configurations 26 | 27 | Add custom retroarch controls to the retroarch.cfg file in 28 | ```shell 29 | /opt/retropie/configs/wonderswancolor/retroarch.cfg 30 | ``` 31 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) -------------------------------------------------------------------------------- /docs/Playstation-2.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![ps2_vertical](https://cloud.githubusercontent.com/assets/10035308/18609396/53f3a13a-7cbe-11e6-85bd-cf96a8d15034.png) 3 | *** 4 | _The PlayStation 2 is a home video game console released by Sony in 2000._ 5 | *** 6 | 7 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 8 | | :---: | :---: | :---: | :---: | :---: | 9 | | [PCSX2](http://pcsx2.net/) | ps2 | .iso .img .bin .mdf .z .z2 .bz2 .dump .cso .ima .gz | rom1.bin, rom2.bin, erom.bin, SCPH-XXXXX.nvm | | 10 | 11 | > **Note This is only for x86/x86_64 builds- Not the Raspberry Pi!.** 12 | 13 | ## Emulators: [PCSX2](http://pcsx2.net/) 14 | 15 | ## ROMS 16 | Accepted File Extensions: **.iso .img .bin .mdf .z .z2 .bz2 .dump .cso .ima .gz** 17 | 18 | Place your PlayStation 2 ROMs in 19 | ``` 20 | /home/pi/RetroPie/roms/ps2 21 | ``` 22 | 23 | ## BIOS 24 | Place your Playstation 2 BIOS in 25 | ``` 26 | /home/pi/.config/PCSX2/bios/ 27 | ``` 28 | On first run the GUI will ask you to select which BIOS to use. Select the appropriate one and use iso' that match that region. 29 | ## Controls 30 | 31 | ![playstation3_diagram](https://cloud.githubusercontent.com/assets/10035308/16599634/7f353148-42c0-11e6-9023-dbaf074bc933.png) -------------------------------------------------------------------------------- /docs/SG-1000.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![sg-1000](https://cloud.githubusercontent.com/assets/10035308/12213981/65649382-b641-11e5-8499-dfecbb496ff5.png) 3 | *** 4 | _The Sega SG-1000 is the first home video game console released by Sega in 1983._ 5 | *** 6 | 7 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 8 | | :---: | :---: | :---: | :---: | :---: | 9 | | [lr-genesis-plus-gx](https://github.com/libretro/Genesis-Plus-GX) | sg-1000 | .7z .bin .sg .zip | none | /opt/retropie/configs/sg-1000/retroarch.cfg | 10 | 11 | ## Emulator: [lr-genesis-plus-gx](https://github.com/libretro/Genesis-Plus-GX) 12 | 13 | ## ROMS 14 | 15 | Accepted File Extensions: **.7z .bin .sg .zip** 16 | 17 | Place your Sega SG-1000 ROMs in 18 | ``` 19 | /home/pi/RetroPie/roms/sg-1000 20 | ``` 21 | 22 | ## Controls 23 | 24 | lr-genesis-plus-gx utilises Retroarch configurations 25 | 26 | Add custom retroarch controls to the retroarch.cfg file in 27 | ```shell 28 | /opt/retropie/configs/sg-1000/retroarch.cfg 29 | ``` 30 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) 31 | 32 | ![sg-1000](https://cloud.githubusercontent.com/assets/10035308/8177182/4703423c-13bf-11e5-9cc7-54b156155d8d.png) -------------------------------------------------------------------------------- /docs/Coco.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![coco](https://cloud.githubusercontent.com/assets/10035308/12190919/701943ba-b58b-11e5-991c-5839099607d8.png) 3 | *** 4 | _The Tandy Colour Computer series were home computers originally released by the Tandy Corporation in 1980._ 5 | *** 6 | 7 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 8 | | :---: | :---: | :---: | :---: | :---: | 9 | | [XRoar](http://www.6809.org.uk/xroar/) | coco | .bin .cas .wav .bas .asc .dmk .jvc .os9 .dsk .vdk .rom .ccc .sna | bas13.rom, extbas11.rom, coco3.rom, coco3p.rom | hardcoded | 10 | 11 | ## Emulator: [XRoar](http://www.6809.org.uk/xroar/) 12 | 13 | ## ROMS 14 | Accepted File Extensions: **.cas .wav .bas .asc .dmk .jvc .os9 .dsk .vdk .rom .ccc .sna** 15 | 16 | Place your CoCo ROMs in 17 | ``` 18 | /home/pi/RetroPie/roms/coco 19 | ``` 20 | ## BIOS 21 | 22 | Depending on the emulated model, different BIOS files are need to be copied to 23 | 24 | ``` 25 | /home/pi/RetroPie/BIOS 26 | ``` 27 | 28 | | Machine | BIOS file name | Size | 29 | | :- | :- | :- | 30 | | Tandy Colour BASIC | bas13.rom | 8K | 31 | | Tandy Extended BASIC | extbas11.rom | 8K | 32 | | Tandy Super ECB (CoCo 3) | coco3.rom 32K | (32768 bytes) | 33 | | Tandy Super ECB (PAL CoCo 3) | coco3p.rom | 32K (32768 bytes) | 34 | -------------------------------------------------------------------------------- /docs/Gamepad-G910-bluetooth-controler.md: -------------------------------------------------------------------------------- 1 | G910 is a quite common bluetooth controller used with android/iPhone devices to play a mobile games. 2 | 3 | How to pair with RetroPie 4 | * G910 shall je switched off 5 | * * To switch it off press Home button for 5 secs 6 | * Pairing mode shall be entered by pressing A + Home buttons together 7 | * * all four red lights shall start flashing quickly, if not pairing mode was not initiated, repeat previous steps again 8 | * * Warning, there are 4 pairing modes but only one work with with retropie 9 | * * * A + Home: keyboard pairing mode (use this one) 10 | * * * X + Home: gamepad pairing mode 11 | * * * B + Home: app pairing mode 12 | * * * Y + Home: icade pairing mode (ios compatible) 13 | * start bluetoothctl from command line and type following commands 14 | * * pairable on 15 | * * scan on 16 | * * * wait until gamepad address appears 17 | * * trust [gamepad address] 18 | * * pair [gamepad address] 19 | * * connect [gamepad address] 20 | * * * successful connection is indicated by second led on, the others are off 21 | * reboot your retropie, after rebooting gamepad shall connect automatically, if it is switched off just switched it on by short press by Home button 22 | * long press of aby button shall start kdy mapping wizard -------------------------------------------------------------------------------- /docs/ZX81.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![zx81](https://user-images.githubusercontent.com/22881403/41500759-734cd052-715d-11e8-9177-2732ee91152c.png) 3 | *** 4 | _The ZX81 is a home computer released by Sinclair in 1981. It was designed to be a low-cost entry computer for the general public. It sold 1.5 million units by the end of it's life._ 5 | *** 6 | 7 | | Emulator | Rom Folder | Extension | 8 | | :---: | :---: | :---: | 9 | | [lr-81](https://github.com/libretro/81-libretro) | zx81 | .p .tzx .t81 | 10 | 11 | ## Emulator: [lr-81](https://github.com/libretro/81-libretro) 12 | This emulator can be installed from the experimental menu of the [RetroPie-Setup script.](Updating-RetroPie#using-the-retropie-setup-script) 13 | 14 | Due to a bug in the emulator, you will have to set Player 2's controller type to "Sinclair Keyboard" in order to send inputs. 15 | 16 | ## ROMS 17 | 18 | Accepted File Extensions: **.p .tzx .t81** 19 | 20 | Place your ZX-81 ROMs in: 21 | ``` 22 | /home/pi/RetroPie/roms/zx81 23 | ``` 24 | 25 | ## Controls 26 | 27 | lr-81 utilises Retroarch configurations. 28 | 29 | Add custom retroarch controls to the retroarch.cfg file in 30 | ```shell 31 | /opt/retropie/configs/zx81/retroarch.cfg 32 | ``` 33 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) -------------------------------------------------------------------------------- /docs/Vectrex.md: -------------------------------------------------------------------------------- 1 | ![Vectrex](https://upload.wikimedia.org/wikipedia/commons/e/ef/Vectrex_vector_logo.svg) 2 | ![Vectrex console](https://upload.wikimedia.org/wikipedia/commons/thumb/7/7a/Vectrex-Console-Set.jpg/192px-Vectrex-Console-Set.jpg) 3 | *** 4 | _The Vectrex is a vector display-based home video game console released in 1982. On October 27, 1992, Smith Engineering granted permission for the original Vectrex ROMs, manuals, and other original content to be freely distributed for non-commercial purposes._ 5 | *** 6 | 7 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 8 | | :---: | :---: | :---: | :---: | :---: | 9 | | [lr-vecx](https://github.com/libretro/libretro-vecx) | vectrex | .7z .bin .gam .vec .zip | none | /opt/retropie/configs/vectrex/retroarch.cfg | 10 | 11 | ## Emulator: [lr-vecx](https://github.com/libretro/libretro-vecx) 12 | 13 | ## ROMS 14 | 15 | Accepted File Extensions: **.7z .bin .gam .vec .zip** 16 | 17 | Place your Vectrex ROMs in 18 | ``` 19 | /home/pi/RetroPie/roms/vectrex 20 | ``` 21 | 22 | ## Controls 23 | 24 | lr-vecx utilises Retroarch configurations 25 | 26 | Add custom retroarch controls to the retroarch.cfg file in 27 | ```shell 28 | /opt/retropie/configs/vectrex/retroarch.cfg 29 | ``` 30 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) 31 | 32 | ![vectrex](https://cloud.githubusercontent.com/assets/10035308/8196876/168671c6-144e-11e5-8139-d2d980a936fa.png) -------------------------------------------------------------------------------- /docs/Minecraft.md: -------------------------------------------------------------------------------- 1 | ![Minecraft Pi Logo](https://www.teachwithict.com/uploads/5/5/8/2/5582303/1404981123_1.jpg) 2 | *** 3 | _Minecraft was created by Markus "Notch" Persson and his company Mojang which was later sold to Microsoft for 2.5 billion dollars- which explains why there has been pretty much no development on Minecraft Pi edition for more than 2 years now. Minecraft for Pi is based off of Minecraft Pocket Edition, and as such lacks creatures, adventures, night time, etc. It is unfortunately incredibly basic._ 4 | *** 5 | 6 | This emulator is experimental and can be installed from the experimental menu of the [retropie setup script](Updating-RetroPie). This cannot be installed on the Raspberry Pi 4 or 400. 7 | 8 | ## Controls 9 | 10 | Key | Action 11 | :---: | :---: 12 | W | Forward 13 | A | Left 14 | S | Down 15 | D | Right 16 | E | Inventory 17 | Space | Jump 18 | Double Space | Fly / Fall 19 | Esc | Pause / Game menu 20 | Tab | Release mouse cursor 21 | 1-8 | Block selection 22 | Mouse | Direction of Movement 23 | Left-Click | Remove Block 24 | Right-Click | Place Block 25 | Scroll-Wheel | Select Block 26 | 27 | **Important notes:** 28 | 29 | In order to work with fullscreen, a window manager called Matchbox is used, but it has a side effect of the mouse not quite working right in the menu so you need to use a keyboard to start up a world. Once you are in the world, the mouse works just fine. 30 | 31 | To exit, you can either click the x in the upper right of the screen or you can reboot your pi. 32 | -------------------------------------------------------------------------------- /docs/Pokemon-Mini.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![pokemini](https://user-images.githubusercontent.com/22881403/45140090-634cc400-b177-11e8-8dae-1f9496366245.png) 3 | *** 4 | _The Pokemon Mini is a handheld game console that was released by Nintendo in 2001. All of the games released for it were themed around Nintendo's *Pokemon* franchise._ 5 | *** 6 | 7 | | Emulator | Rom Folder | Extension | 8 | | :---: | :---: | :---: | 9 | | [lr-pokemini](https://github.com/libretro/pokemini) | pokemini | .min .zip | 10 | 11 | ## Emulator: [lr-pokemini](https://github.com/libretro/pokemini) 12 | This emulator can be installed from the experimental menu of the [RetroPie-Setup script.](Updating-RetroPie#using-the-retropie-setup-script) 13 | 14 | ## ROMS 15 | 16 | Accepted File Extensions: **.min .zip** 17 | 18 | Place your Pokemon Mini ROMs in: 19 | ``` 20 | /home/pi/RetroPie/roms/pokemini 21 | ``` 22 | ## BIOS 23 | 24 | ### lr-pokemini 25 | 26 | lr-pokemini supports the **bios.min** BIOS file, but it isn't required. 27 | 28 | Place the BIOS in 29 | ``` 30 | /home/pi/RetroPie/BIOS 31 | ``` 32 | 33 | | Recognized Name | No-Intro Name | md5sum | CRC32 | 34 | | :--: | :--: | :--: | :--: | 35 | | bios.min | [BIOS] Nintendo Pokemon Mini (World) | 1E4FB124A3A886865ACB574F388C803D | AED3C14D | 36 | 37 | ## Controls 38 | 39 | lr-pokemini utilises Retroarch configurations. 40 | 41 | Add custom retroarch controls to the retroarch.cfg file in 42 | ```shell 43 | /opt/retropie/configs/pokemini/retroarch.cfg 44 | ``` 45 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) -------------------------------------------------------------------------------- /docs/Atari-7800.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![atari7800](https://cloud.githubusercontent.com/assets/10035308/12190354/dbcd3aaa-b584-11e5-9c4f-89d0d7adc783.png) 3 | *** 4 | _The Atari 7800 was a video game console released by Atari in 1986._ 5 | *** 6 | 7 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 8 | | :---: | :---: | :---: | :---: | :---: | 9 | | [lr-prosystem](https://github.com/libretro/prosystem-libretro) | atari7800 | .7z .a78 .bin .zip | 7800 BIOS (U).rom | /opt/retropie/configs/atari7800/retroarch.cfg | 10 | 11 | ## Emulator: [lr-prosystem](https://github.com/libretro/prosystem-libretro) 12 | 13 | ## ROMS 14 | Accepted File Extensions: **.7z .a78 .bin .zip** 15 | 16 | Place your Atari ROMs in 17 | ``` 18 | /home/pi/RetroPie/roms/atari7800 19 | ``` 20 | 21 | ## BIOS 22 | This BIOS is optional if you want the Atari Logo at the beginning of games, otherwise you don't need it because the games work fine without it. The BIOS file name is **7800 BIOS (U).rom** 23 | 24 | Place your Atari 7800 BIOS in 25 | ``` 26 | /home/pi/RetroPie/BIOS/ 27 | ``` 28 | Note: if this BIOS is enabled, PAL ROMs will not work so use it accordingly. 29 | 30 | ## Controls 31 | 32 | lr-prosystem utilises Retroarch configurations 33 | 34 | Add custom retroarch controls to the retroarch.cfg file in 35 | ```shell 36 | /opt/retropie/configs/atari7800/retroarch.cfg 37 | ``` 38 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) 39 | 40 | ![atari7800diagram](https://cloud.githubusercontent.com/assets/10035308/8268732/d7b4236c-174a-11e5-8386-6fa948235267.png) -------------------------------------------------------------------------------- /docs/TI-99.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![ti-99-logo](https://cloud.githubusercontent.com/assets/10035308/15901958/cd2fe5dc-2d62-11e6-9c22-7213d37ebc89.png) 3 | *** 4 | _The TI-99/4A was a home computer originally released by the Texas Instruments in 1981._ 5 | *** 6 | 7 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 8 | | :---: | :---: | :---: | :---: | :---: | 9 | | [ti99sim](http://www.mrousseau.org/programs/ti99sim/) | ti99 | .ctg | TI-994A.ctg | hardcoded | 10 | 11 | ## Emulator: [ti99sim](http://www.mrousseau.org/programs/ti99sim/) 12 | 13 | ## ROMS 14 | Accepted File Extensions: **.ctg** 15 | 16 | Place your TI-99 ROMs in 17 | ``` 18 | /home/pi/RetroPie/roms/ti99 19 | ``` 20 | 21 | ## BIOS 22 | 23 | The file needed is **TI-994A.ctg** (CASE SENSITIVE!) 24 | 25 | Place your TI-994A.ctg BIOS file in 26 | ``` 27 | /home/pi/RetroPie/BIOS 28 | ``` 29 | 30 | ## INSTALLATION INSTRUCTIONS (VERSION 2.0) 31 | TI-99/Sim v0.14.0 and RetroPie V3.8.1 32 | 33 | [Updated Installation Instruction V.20](http://www.globeron.com/freedownload/services/TI99/TI-99-Sim-Installation-on-RaspberryPI2ModelB-RetroPieV381-DocV2.pdf) 34 | 35 | 36 | 37 | [Installation Instructions v1.0 (AtariAge)](http://atariage.com/forums/topic/250767-how-to-install-ti-994a-ti-99sim-on-retropie-v36-raspberry-pi2-or-pi3/#entry3491795) 38 | 39 | -------------------------------------------------------------------------------- /docs/Atari-Jaguar.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![atarijaguar](https://cloud.githubusercontent.com/assets/10035308/12190454/f776b6a4-b585-11e5-9b8b-1f7ed69480b3.png) 3 | *** 4 | _The Atari Jaguar was the first 64 bit video game console released in 1993. It was a bad enough commercial failure that it put Atari out of the home video game console business._ 5 | 6 | *** 7 | 8 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 9 | | :---: | :---: | :---: | :---: | :---: | 10 | | [lr-virtualjaguar](https://github.com/libretro/virtualjaguar-libretro) | atarijaguar | .j64 .jag | none | /opt/retropie/configs/atarijaguar/retroarch.cfg | 11 | 12 | ## Emulator: [lr-virtualjaguar](https://github.com/libretro/virtualjaguar-libretro) 13 | 14 | **lr-virtualjaguar** is experimental and too slow for most Raspberry Pi systems, but with an overclocked Pi4 it's possible to run some games at full speed. See [this forum topic](https://retropie.org.uk/forum/topic/27999/) for an overview of the tested games and the overclock settings used. 15 | 16 | ## ROMS 17 | 18 | Accepted File Extensions: **.j64 .jag** 19 | 20 | Place your Atari Jaguar ROMs in 21 | ``` 22 | /home/pi/RetroPie/roms/atarijaguar 23 | ``` 24 | ## Controls 25 | 26 | lr-virtualjaguar utilises Retroarch configurations 27 | 28 | Add custom retroarch controls to the retroarch.cfg file in 29 | ```shell 30 | /opt/retropie/configs/atarijaguar/retroarch.cfg 31 | ``` 32 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) 33 | 34 | ![atarijaguardiagram](https://cloud.githubusercontent.com/assets/10035308/8268598/4a5d1868-1748-11e5-994d-e0d508d8877b.png) 35 | -------------------------------------------------------------------------------- /docs/Sharp-X1.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![x1](https://user-images.githubusercontent.com/22881403/46316267-544e0b80-c595-11e8-8824-bf4042eaf6fd.png) 3 | *** 4 | _The X1, sometimes called the Sharp X1, is a series of home computers released by Sharp Corporation from 1982 to 1988. It was based on a Z80 CPU._ 5 | *** 6 | 7 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 8 | | :---: | :---: | :---: | :---: | :---: | 9 | | [lr-x1](https://github.com/r-type/xmil-libretro) | x1 | .dx1 .zip .2d .2hd .tfd .d88 .88d .hdm .xdf .dup .cmd | IPLROM.X1, IPLROM.X1T | /opt/retropie/configs/x1/retroarch.cfg | 10 | 11 | ## Emulator: [lr-x1](https://github.com/r-type/xmil-libretro) 12 | This emulator is a work in progress. It can be installed from the experimental menu of the [RetroPie-Setup script](Updating-RetroPie#using-the-retropie-setup-script). 13 | 14 | Note that the emulator freezes if you attempt to load a ROM through the emulator's built-in GUI. 15 | 16 | ## ROMS 17 | 18 | Accepted File Extensions: **.dx1 .zip .2d .2hd .tfd .d88 .88d .hdm .xdf .dup .cmd** 19 | 20 | Place your Sharp X1 ROMs in: 21 | ``` 22 | /home/pi/RetroPie/roms/x1 23 | ``` 24 | 25 | 26 | ## BIOS 27 | 28 | Place your BIOS files in: 29 | ``` 30 | /home/pi/RetroPie/BIOS/xmil 31 | ``` 32 | 33 | ## BIOS files 34 | 35 | | File | CRC32 | 36 | | :--: | :--: | 37 | | IPLROM.X1 | 7B28D9DE | 38 | | IPLROM.X1T | 2E8B767C | 39 | 40 | ## Controls 41 | 42 | lr-x1 utilises Retroarch configurations. 43 | 44 | Add custom retroarch controls to the retroarch.cfg file in 45 | ```shell 46 | /opt/retropie/configs/x1/retroarch.cfg 47 | ``` 48 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) -------------------------------------------------------------------------------- /docs/Nintendo-Switch-Controllers.md: -------------------------------------------------------------------------------- 1 | ## Installation 2 | 3 | First, you need to install [dkms-hid-nintendo](https://github.com/nicman23/dkms-hid-nintendo), a Nintendo HID kernel module: 4 | 5 | ```shell 6 | git clone https://github.com/nicman23/dkms-hid-nintendo 7 | cd dkms-hid-nintendo 8 | sudo dkms add . 9 | sudo dkms build nintendo -v 3.2 10 | sudo dkms install nintendo -v 3.2 11 | ``` 12 | 13 | **NOTE** : the module version may change, check the [driver's page](https://github.com/nicman23/dkms-hid-nintendo) for the correct version to be used with the `dkms` commands above. 14 | 15 | 16 | Then, you need [joycond](https://github.com/DanielOgorchock/joycond), a userspace driver which manages the controllers and exposes their motion inputs. 17 | 18 | On a fresh install, you might need to install the libevdev library first: 19 | 20 | ```shell 21 | sudo apt-get install libevdev-dev 22 | ``` 23 | 24 | Then install the joycond itself: 25 | 26 | ```shell 27 | git clone https://github.com/DanielOgorchock/joycond.git 28 | cd joycond 29 | cmake . 30 | sudo make install 31 | sudo systemctl enable --now joycond 32 | ``` 33 | ## Usage 34 | 35 | Just like in a Nintendo Switch, after you connect it to Retropie through Bluetooth in the Retropie Menu (press the button next to the USB-C port to put the controller in pairing mode), you'll need to press triggers to select the position. After you press any button and the player indicator lights start blinking, do the following: 36 | 37 | |Position/Controller|Buttons to press| 38 | |--|--| 39 | | One Joycon, Horizontal |Press **SR+SL** | 40 | |One Joycon, Vertical |Press **L and ZL** or **R and ZR** | 41 | |Two Joycons/Pro Controller |Press **L or ZL** and **R or ZR** | 42 | -------------------------------------------------------------------------------- /docs/Atari-Lynx.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![atarilynx](https://cloud.githubusercontent.com/assets/10035308/12190664/6ef7c284-b588-11e5-9dc2-875676e9ea78.png) 3 | *** 4 | _The Atari Lynx is the world's first handheld gaming console with a color screen. It was released by Atari in 1989_ 5 | *** 6 | 7 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 8 | | :---: | :---: | :---: | :---: | :---: | 9 | | [lr-handy](https://github.com/libretro/libretro-handy) | atarilynx | .7z .lnx .zip | lynxboot.img (optional)| /opt/retropie/configs/atarilynx/retroarch.cfg | 10 | | [lr-beetle-lynx](https://github.com/libretro/beetle-lynx-libretro) | atarilynx | .7z .lnx .zip | lynxboot.img | /opt/retropie/configs/atarilynx/retroarch.cfg | 11 | 12 | ## Emulator: [lr-handy](https://github.com/libretro/libretro-handy), [lr-beetle-lynx](https://github.com/libretro/beetle-lynx-libretro) 13 | 14 | ## ROMS 15 | Accepted File Extensions: **.7z .lnx .zip** 16 | 17 | Place your Lynx ROMS in: 18 | ```shell 19 | /home/pi/RetroPie/roms/atarilynx/ 20 | ``` 21 | ## BIOS 22 | 23 | The file needed is **lynxboot.img** (only for lr-beetle-lynx) 24 | 25 | Place your lynxboot.img BIOS file in 26 | ``` 27 | /home/pi/RetroPie/BIOS 28 | ``` 29 | 30 | | File | md5sum | CRC32 | 31 | | :--: | :--: | :--: | 32 | | lynxboot.img | fcd403db69f54290b51035d82f835e7b | 0d973c9d | 33 | 34 | ## Controls 35 | 36 | lr-handy utilises Retroarch configurations 37 | 38 | Add custom RetroArch controls to the retroarch.cfg file in: 39 | ```shell 40 | /opt/retropie/configs/atarilynx/retroarch.cfg 41 | ``` 42 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) 43 | 44 | ![atari_lynx_diagram](https://cloud.githubusercontent.com/assets/10035308/16599640/7f435408-42c0-11e6-8034-d04fec9310ce.png) -------------------------------------------------------------------------------- /docs/Oric.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![oric](https://cloud.githubusercontent.com/assets/10035308/15935500/afacfd8e-2e24-11e6-9c78-ef2b60a4f8e1.png) 3 | 4 | *** 5 | _The Oric was a series of home computers originally released by the Tangerine Computer Systems in 1983. Models emulated include Oric-1, Oric Atmos, Stratos/IQ164, and Oric Telestrat._ 6 | *** 7 | 8 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 9 | | :---: | :---: | :---: | :---: | :---: | 10 | | [oricutron](https://github.com/pete-gordon/oricutron) | oric | .dsk .tap | none | hardcoded | 11 | 12 | ## Emulator: [oricutron](https://github.com/pete-gordon/oricutron) 13 | This emulator must be installed from the experimental section in RetroPie Setup. 14 | 15 | ## ROMS 16 | Accepted File Extensions: **.dsk .tap** 17 | 18 | Place your oric ROMs in 19 | ``` 20 | /home/pi/RetroPie/roms/oric 21 | ``` 22 | 23 | ## Controls: 24 | 25 | ``` 26 | In emulator 27 | ----------- 28 | 29 | F1 - Bring up the menu 30 | F2 - Go to debugger/monitor 31 | F3 - Reset button (NMI) 32 | F4 - Hard reset 33 | Shift+F4 - Jasmin reset 34 | F5 - Toggle FPS 35 | F6 - Toggle warp speed 36 | F7 - Save all modified disks 37 | Shift+F7 - Save all modified disks to new disk images 38 | F8 - Toggle fullscreen 39 | F9 - Save tape output 40 | F10 - Start/Stop AVI capture 41 | F11 - Copy text screen to clipboard (BeOS, Linux & Windows) 42 | F12 - Paste (BeOS, Linux & Windows) 43 | Help - Show guide (Amiga, MorphOS and AROS) 44 | AltGr - Additional modifier 45 | 46 | 47 | In menus 48 | -------- 49 | 50 | Cursors - Navigate 51 | Enter - Perform option 52 | Backspace - Go back 53 | Escape - Exit menus 54 | (or use the mouse) 55 | ``` -------------------------------------------------------------------------------- /docs/Game-&-Watch.md: -------------------------------------------------------------------------------- 1 | *** 2 | 3 | ![game_and_watch_banner](https://cloud.githubusercontent.com/assets/10035308/13205492/9b6db396-d8a6-11e5-8a74-51b2a74a0f35.png) 4 | 5 | *** 6 | _Game & Watch is a line of handheld electronic games produced by Nintendo from 1980 to 1991._ 7 | 8 | *** 9 | 10 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 11 | | :---: | :---: | :---: | :---: | :---: | 12 | | [lr-gw](https://github.com/libretro/gw-libretro) | gameandwatch | .mgw | none | /opt/retropie/configs/gameandwatch/retroarch.cfg | 13 | 14 | ## Emulator: [lr-gw](https://github.com/libretro/gw-libretro) 15 | 16 | **lr-gw** is a simulator and not an emulator. This means that the games that can be played with it aren't actually the original games, but recreations of the games combined with the original artwork and an image of the handheld. 17 | 18 | ## ROMS 19 | Accepted File Extensions: **.mgw** 20 | 21 | Place your Game & Watch ROMs in 22 | ``` 23 | /home/pi/RetroPie/roms/gameandwatch 24 | ``` 25 | 26 | Games can be found at the [Libretro Handheld Electronic Games page](https://bot.libretro.com/assets/cores/Handheld%20Electronic%20Game/). 27 | 28 | ### Video Guide 29 | 30 | 31 | 32 | ## Controls 33 | 34 | lr-gw utilises Retroarch configurations 35 | 36 | Add custom retroarch controls to the retroarch.cfg file in 37 | ```shell 38 | /opt/retropie/configs/gameandwatch/retroarch.cfg 39 | ``` 40 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) 41 | -------------------------------------------------------------------------------- /docs/Zmachine.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![z-machine](https://cloud.githubusercontent.com/assets/10035308/12212915/3dbf6b90-b62d-11e5-8f13-0b1a61bcbdf8.png) 3 | *** 4 | _Infocom created a bunch of text based adventure games to be utilised by a Z-Machine interpreter (i.e. an emulator). Notable titles include the Zork Series and The Hitchhikers Guide to the Galaxy._ 5 | 6 | *** 7 | 8 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 9 | | :---: | :---: | :---: | :---: | :---: | 10 | | [Frotz](http://frotz.sourceforge.net/) | zmachine | .dat .zip .z1 .z2 .z3 .z4 .z5 .z6 .z7 .z8 | none | hardcoded | 11 | 12 | ## Emulator: [Frotz](http://frotz.sourceforge.net/) 13 | 14 | ## ROMS 15 | Accepted File Extensions: **.dat .zip .z1 .z2 .z3 .z4 .z5 .z6 .z7 .z8** 16 | 17 | Place your Infocom interactive fiction ROMs in 18 | ``` 19 | /home/pi/RetroPie/roms/zmachine 20 | ``` 21 | 22 | ## Controls 23 | 24 | It's a very different type of gameplay than typical gaming systems. It is more of an interactive storybook than it is a video game. 25 | 26 | By default 3 versions of Zork are already in the Z-Machine ROM folder 27 | 28 | Follow the onscreen instructions and type responses- So for example it narrates that it is dark- in turn you type `light` or `turn on light` and then it will progress in the story. 29 | 30 | If you get tired of the story and would like to quit, just type: `quit` at the prompt. 31 | 32 | ## Larger Font Size 33 | 34 | If you are on a high resolution screen and the font size is tiny you can change the framebuffer's resolution using the [runcommand](Runcommand) menu to 640x480 and it should make the font more visible. As an alternative to the [Runcommand](Runcommand) launch menu, you can use the [Consolefonts](FAQ.md#how-can-i-increase-the-console-font-size) module to change the font size globally on your RetroPie system. -------------------------------------------------------------------------------- /docs/TRS-80.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![trs-80](https://cloud.githubusercontent.com/assets/10035308/15901462/a43326d2-2d60-11e6-9607-ee959ea30b40.png) 3 | *** 4 | _The TRS-80 was a home computer originally released by the Tandy Corporation in 1977. T=Tandy RS=Radio Shack 80=Z-80 microprocessor._ 5 | *** 6 | 7 | | Emulator | Rom Folder | trs-80 type | Extension | BIOS | Controller Config | 8 | | :---: | :---: | :---: | :---: | :---: | :---: | 9 | | [sdltrs](https://github.com/RetroPie/sdltrs) | trs-80 | trs-80 model I | .dsk | level2.rom | hardcoded | 10 | | [sdltrs](https://github.com/RetroPie/sdltrs) | trs-80 | trs-80 model III | .dsk | level3.rom | hardcoded | 11 | | [sdltrs](https://github.com/RetroPie/sdltrs) | trs-80 | trs-80 model 4 | .dsk | level4.rom | hardcoded | 12 | | [sdltrs](https://github.com/RetroPie/sdltrs) | trs-80 | trs-80 model 4P | .dsk | level4P.rom | hardcoded | 13 | 14 | 15 | ## Emulator: [sdltrs](https://github.com/RetroPie/sdltrs) 16 | 17 | ## ROMS 18 | Accepted File Extensions: **.dsk** 19 | 20 | Place your TRS-80 ROMs in 21 | ``` 22 | /home/pi/RetroPie/roms/trs-80 23 | ``` 24 | 25 | ## BIOS 26 | 27 | The BIOS file needed is **level2.rom** for Model I, **level3.rom** for Model III, **level4.rom** for Model 4 and **level4p.rom** for Model 4P. An overview of the options for legally obtaining one of the various compatible BIOS files can be found [in the sdltrs README file](https://github.com/RetroPie/sdltrs). 28 | 29 | Place your level2.rom BIOS file in 30 | ``` 31 | /home/pi/RetroPie/BIOS 32 | ``` 33 | 34 | ## Controls: 35 | 36 | - F7: Emulator Options 37 | - F10: Reset Emulator 38 | - F12: System Menu (Quit) 39 | 40 | ### Advanced Configuration 41 | 42 | For more detailed information on autolaunching disks and games see this guide [HERE](https://github.com/RetroPie/RetroPie-Setup/files/114630/sdltrs.configuration.pdf) -------------------------------------------------------------------------------- /docs/Xiaomi-Controller.md: -------------------------------------------------------------------------------- 1 | After pairing the device as shown in this [guide](https://retropie.org.uk/docs/Bluetooth-Controller/) and mapping it through emulationstation menú, the first thing you will notice is that it isn't working ingame. 2 | 3 | The problem is that the keys detected in emulationstation are not the same as the ones detected in retroarch. To fix this you can either bind the keys through the retroarch config (in emulationstation: Retropie -> Retroarch -> Config -> Input) or start from the following cfg that must be placed at `/opt/retropie/configs/all/retroarch-joypads/udev/小米蓝牙手柄.cfg`. The name is the same as the one in `/opt/retropie/configs/all/retroarch-joypads` that represents the Xiaomi Gamepad. 4 | 5 | ``` 6 | input_device = "小米蓝牙手柄" 7 | input_driver = "udev" 8 | input_r_y_plus_axis = "+5" 9 | input_l3_btn = "17" 10 | input_r_x_minus_axis = "-2" 11 | input_l_btn = "10" 12 | input_load_state_btn = "10" 13 | input_start_btn = "15" 14 | input_exit_emulator_btn = "15" 15 | input_l_y_minus_axis = "-1" 16 | input_up_btn = "h0up" 17 | input_r_y_minus_axis = "-5" 18 | input_a_btn = "4" 19 | input_b_btn = "5" 20 | input_reset_btn = "5" 21 | input_down_btn = "h0down" 22 | input_l_x_plus_axis = "+0" 23 | input_l_y_plus_axis = "+1" 24 | input_r_btn = "11" 25 | input_save_state_btn = "11" 26 | input_r2_btn = "13" 27 | input_r3_btn = "18" 28 | input_right_btn = "h0right" 29 | input_state_slot_increase_btn = "h0right" 30 | input_x_btn = "7" 31 | input_menu_toggle_btn = "7" 32 | input_select_btn = "14" 33 | input_enable_hotkey_btn = "14" 34 | input_l_x_minus_axis = "-0" 35 | input_y_btn = "8" 36 | input_left_btn = "h0left" 37 | input_state_slot_decrease_btn = "h0left" 38 | input_r_x_plus_axis = "+2" 39 | input_l2_btn = "12" 40 | ``` 41 | 42 | Keep in mind that this configuration is based in the Xbox 360 Controller Scheme and uses the default joypad hotkeys -------------------------------------------------------------------------------- /docs/Cave-Story.md: -------------------------------------------------------------------------------- 1 | ![CaveStory Logo](http://upload.wikimedia.org/wikipedia/en/8/83/Cave_Story_title_screen.png) 2 | *** 3 | _Cave Story (doukutsu monogatari) is a Freeware Platform-Adventure Video Game Released in 2004 for the PC. It was developed over 5 years by Daisuke "Pixel" Amaya in his free time. It is one of the greatest most beautifully crafted games, particularly because of its compelling plot and musical genius._ 4 | *** 5 | ## Emulator: [nxengine-libretro](https://github.com/libretro/nxengine-libretro) 6 | 7 | ## ROMs 8 | 9 | **NOTE:** You must install the optional "lr-nxengine" package via the RetroPie setup script, otherwise, Cave Story will not show up in the list of available Ports. 10 | 11 | After the installation of the `lr-nxengine` package, create a folder called `CaveStory` in 12 | ``` 13 | /home/pi/RetroPie/roms/ports/ 14 | ``` 15 | Add all of the game files into the CaveStory folder - particularly `Doukotsu.exe` - into 16 | ``` 17 | /home/pi/RetroPie/roms/ports/CaveStory 18 | ``` 19 | If it is in Japanese, there is a game patch by Aeon Genesis that will make it English. 20 | Due to Copyrights we can't provide sources, but Google is your friend. 21 | 22 | ## Controls 23 | 24 | nxengine-libretro uses Retroarch configurations. Add custom retroarch controls to the `retroarch.cfg` file in 25 | ```shell 26 | /opt/retropie/configs/ports/cavestory/retroarch.cfg 27 | ``` 28 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) 29 | 30 | ## Saves 31 | nxengine-libretro does not support save states, but Cave Story itself includes many in-game save points and multiple profiles. Save profile files will be be saved as: 32 | ``` 33 | /home/pi/RetroPie/roms/ports/CaveStory/profile.dat 34 | /home/pi/RetroPie/roms/ports/CaveStory/profile2.dat 35 | /home/pi/RetroPie/roms/ports/CaveStory/profile3.dat 36 | ``` -------------------------------------------------------------------------------- /docs/stylesheets/extra.css: -------------------------------------------------------------------------------- 1 | :root > * { 2 | /* Primary color shades */ 3 | --md-primary-fg-color: #222; 4 | --md-primary-fg-color--dark: #222; 5 | 6 | /* Accent color shades for links */ 7 | --md-accent-fg-color: #FF0000; 8 | --md-primary-fg-color: #FF0000; 9 | 10 | /* Make headings bold(er) */ 11 | .md-typeset { h1, h2, h3 { font-weight: 700; } } 12 | } 13 | 14 | /* Fonts: use a 'system' font stack, without loading an external font */ 15 | /* See https://squidfunk.github.io/mkdocs-material/setup/changing-the-fonts/?h=fonts#changing-the-fonts */ 16 | :root { 17 | /* Fonts: use a 'system' font stack, without loading an external font */ 18 | --md-text-font: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol"; 19 | --md-code-font: SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace; 20 | } 21 | 22 | .md-typeset table:not([class]) th:not([align]){text-align:left}.md-typeset table:not([class]) th{ 23 | min-width:10rem; 24 | padding:1.2rem 1.6rem; 25 | background-color:rgba(0, 0, 0, 1); 26 | color:#fff; 27 | vertical-align:top 28 | } 29 | 30 | .md-typeset a { 31 | color: var(--md-accent-fg-color); 32 | } 33 | 34 | article a:hover { 35 | text-decoration: underline; 36 | } 37 | 38 | /* Force header height and color */ 39 | .md-header { 40 | height: 50px; 41 | background-color: #222; 42 | } 43 | 44 | .md-header-nav__button.md-logo { 45 | margin: 0; 46 | padding: 0; 47 | } 48 | 49 | .md-header-nav__button.md-logo img, .md-nav__button img { 50 | height: 50px; 51 | width: 50px; 52 | } 53 | 54 | .md-typeset figcaption { 55 | margin-top: -0.7em; 56 | } 57 | 58 | /* Increase the font size in admonition blocks */ 59 | .md-typeset .admonition,.md-typeset details { 60 | font-size: .75rem; 61 | } 62 | -------------------------------------------------------------------------------- /docs/Sega-32X.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![sega32x](https://cloud.githubusercontent.com/assets/10035308/12212917/3dc2888e-b62d-11e5-8b2c-294b533f838b.png) 3 | *** 4 | _The Sega 32X was released as an add-on for the Sega Genesis/Mega Drive in 1994. There was a whopping total of 40 games for this console; It was considered a commercial failure._ 5 | 6 | *** 7 | 8 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 9 | | :---: | :---: | :---: | :---: | :---: | 10 | | [lr-picodrive](https://github.com/libretro/picodrive) | sega32x | .32x .7z .bin .md .smd .zip | none | /opt/retropie/configs/sega32x/retroarch.cfg | 11 | 12 | ## Emulator: [lr-picodrive](https://github.com/libretro/picodrive) 13 | 14 | ## ROMS 15 | 16 | Accepted File Extensions: **.32x .7z .bin .md .smd .zip** 17 | 18 | Place your Sega 32X ROMs in 19 | ``` 20 | /home/pi/RetroPie/roms/sega32x 21 | ``` 22 | ## Controls 23 | 24 | lr-picodrive utilise RetroArch configurations 25 | 26 | Add custom retroarch controls to the retroarch.cfg file in 27 | 28 | ``` 29 | /opt/retropie/configs/sega32x/retroarch.cfg 30 | ``` 31 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) 32 | 33 | ### 6 Button Controller 34 | 35 | To enable use of the Genesis/Mega Drive 6 button controller, see [6 button controller in lr-picodrive](Mega-Drive-Genesis#lr-picodrive). 36 | 37 | ### 3 Button Genesis/Mega Drive Controller 38 | 39 | ![genesis](https://cloud.githubusercontent.com/assets/10035308/7336303/aec335e0-ebb4-11e4-93b3-26037dd26ffb.png) 40 | 41 | ### 6 Button Genesis/Mega Drive Wireless Controller 42 | 43 | ![sega_megadrive_6button_diagram](https://cloud.githubusercontent.com/assets/10035308/16599642/7f43e53a-42c0-11e6-9152-c33099878ccc.png) 44 | 45 | ### 6 Button Genesis/Mega Drive ArcadePad Controller 46 | 47 | ![sega_megadrive_6button_arcadepad_diagram](https://cloud.githubusercontent.com/assets/10035308/16599641/7f43ae62-42c0-11e6-924a-50ca4e44f401.png) -------------------------------------------------------------------------------- /docs/OpenBOR.md: -------------------------------------------------------------------------------- 1 | 2 | *** 3 | 4 | ![](images/emulators/QSPlNYP.png) 5 | 6 | *** 7 | _OpenBOR is the open source continuation of Beats of Rage - a 2D sidescrolling beat em up game engine._ 8 | *** 9 | ### Emulator: [OpenBOR](https://github.com/rofl0r/openbor.git) 10 | 11 | ### ROMS: 12 | 13 | Accepted extensions: **.pak** 14 | 15 | Place your OpenBOR games in 16 | ``` 17 | /home/pi/RetroPie/roms/ports/openbor 18 | ``` 19 | 20 | Then you need to run 21 | ``` 22 | /opt/retropie/ports/openbor/extract.sh 23 | ``` 24 | 25 | Your games are extracted and ready to be played. Your originals are stored safely in `/home/pi/RetroPie/roms/ports/openbor/original` but they won't be needed anymore. Everything within it can be deleted. 26 | 27 | Alternative to the current extracting script (because the way above fails on FAT32 devices!) use [this extraction script from RetroPie forum.](https://retropie.org.uk/forum/topic/18565/tutorial-openbor-the-complete-guide/57): 28 | 29 | 1. Place your paks to `/home/pi/RetroPie/roms/ports/openbor/pak` 30 | 2. Just run the script. The script extracts all pak-files (even with mixed characters) to the `openbor` directory 31 | 3. Extracted data will be stored to `/home/pi/RetroPie/roms/ports/openbor/gamename.bor/data` 32 | 4. The script backs up the old PAK files automatically (`gamename.pak` will be `gamename.pak.original`) 33 | 34 | For Windows users, just search for `Openbor Makepak & Extractor` and download the toolset. 35 | See more info from the OpenBOR Community [HERE](http://www.chronocrash.com/forum/index.php) 36 | 37 | ### Controls: 38 | 39 | You need a keyboard to navigate the menus or you can setup the system with preconfigurated control settings. Therefore read more in the hints: [OpenBOR - the complete guide](https://retropie.org.uk/forum/topic/18565) 40 | 41 | 42 | ### Hints: 43 | 44 | * [How to create OpenBOR system in ES](https://retropie.org.uk/forum/topic/13784) 45 | * [OpenBOR - the complete guide](https://retropie.org.uk/forum/topic/18565) -------------------------------------------------------------------------------- /docs/Atari-2600.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![atari2600](https://cloud.githubusercontent.com/assets/10035308/12189478/572ad3d8-b57b-11e5-96c3-34e61cc960e3.png) 3 | *** 4 | _The Atari 2600 was a home video game console released by Atari in 1977_ 5 | *** 6 | 7 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 8 | | :---: | :---: | :---: | :---: | :---: | 9 | | [lr-stella](https://github.com/libretro/stella-libretro) | atari2600 | .7z .a26 .bin .gz .rom .zip | none | /opt/retropie/configs/atari2600/retroarch.cfg | 10 | | [Stella](https://stella-emu.github.io/) | atari2600 | .a26 .bin .gz .rom .zip | none | hardcoded | 11 | 12 | ## Emulators: [Stella](http://stella.sourceforge.net/), [lr-stella](https://github.com/libretro/stella-libretro) 13 | 14 | ## ROMS 15 | Accepted File Extensions: **.7z .a26 .bin .gz .rom .zip** 16 | 17 | Place your Atari 2600 ROMS in 18 | ```shell 19 | /home/pi/RetroPie/roms/atari2600/ 20 | ``` 21 | ## Controls 22 | You will configure controls differently depending on which emulator you use: 23 | 24 | ### lr-stella 25 | 26 | lr-stella utilises Retroarch configurations 27 | 28 | Add custom retroarch controls to the retroarch.cfg file in 29 | ```shell 30 | /opt/retropie/configs/atari2600/retroarch.cfg 31 | ``` 32 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) 33 | 34 | 35 | ![atari2600diagram](https://retropie.org.uk/forum/assets/uploads/files/1519507692128-1485898073630-wiki.jpg) 36 | 37 | 38 | ### Stella 39 | 40 | Default Controls: 41 | ```shell 42 | P0 Joystick Up: Up, J0/A1/- 43 | P0 Joystick Down: Down, J0/A1/+ 44 | P0 Joystick Left: Left, J0/A0/- 45 | P0 Joystick Right: Right, J0/A0/+ 46 | P0 Joystick Fire: Space, Lctrl, J0/B0 47 | P0 Booster Top Trigger: 4 48 | P0 Booster Handle Grip: 5 49 | 50 | Configuration Menu: TAB 51 | ``` 52 | 53 | Press Tab to access configuration menu- choose input settings and under the tab Emul. Events you can create custom controller mappings to work for your individual controllers -------------------------------------------------------------------------------- /docs/CHD-files.md: -------------------------------------------------------------------------------- 1 | ## CHD 2 | 3 | CHD is a lossless compression format originally developed for MAME, for the hard-drive contents of certain arcade machines. It has since been used in several other emulators as a means of storing CD-ROM game data. For CD-based games, it compresses the contents of a disc image (`.cue` + `.bin` files) to a single `.chd` file. 4 | 5 | ### Creating CHDs from CD-ROMs 6 | 7 | `CHD` files can be created using the `chdman` program, developed by the [MAME project](https://mamedev.org). 8 | It is a command line application and creating a `.chd` file from an existing `.cue` is performed by running: 9 | 10 | ```shell 11 | chdman createcd -i -o 12 | ``` 13 | 14 | To compress every file in a directory, use: 15 | 16 | ```shell 17 | cd /path/to/folder 18 | for i in *.cue; do chdman createcd -i "$i" -o "${i%.*}.chd"; done 19 | ``` 20 | 21 | To compress every file in subdirectories within a folder, use: 22 | 23 | ```shell 24 | cd /path/to/folder 25 | for i in */*.cue; do chdman createcd -i "$i" -o "${i%.*}.chd"; done 26 | ``` 27 | 28 | 29 | #### Windows 30 | 31 | The following archive contains a MAME 0.205 version of CHDMAN and Windows batch files that can be used to quickly convert your PSX games to CHD (V5): [Download](https://drive.google.com/file/d/0B-ElaPpvBHs5aUd0QUM3c05kY2c/view?usp=sharing) 32 | 33 | Run the appropriate batch file in the same folder as the ROM(s) you wish to compress, and it will search subfolders for `.cue` files to compress. If a `.chd` is not generated after running the appropriate batch, then something is wrong with the ROM(s) `.cue`. 34 | 35 | #### MacOS 36 | 37 | In MacOS, `chdman` can be installed through [Homebrew](https://brew.sh/), with the following command: 38 | 39 | ```shell 40 | brew install rom-tools 41 | ``` 42 | 43 | #### Linux 44 | 45 | On Debian based systems, including RetroPie, `chdman` can be found in the `mame-tools` package and can be installed with: 46 | 47 | ```shell 48 | sudo apt install -y --no-install-recommends mame-tools 49 | ``` 50 | -------------------------------------------------------------------------------- /docs/Wii-U-Pro-Controller.md: -------------------------------------------------------------------------------- 1 | # About 2 | This how-to will explain the fairly easy setup of a Wii U Pro Controller (or any Wii controller) within a jessie based RetroPie Setup. After the setup the controller will connect automatically when it is turned on and can be disconnected off with the power button on the controller. 3 | The steps are based on the XWiimote description in the ArchWiki: https://wiki.archlinux.org/index.php/XWiimote 4 | 5 | # Prerequisites 6 | This will only work on Debian Jessie based distributions. So you either have to get the latest Raspbian version (Debian Jessie based) and use the RetroPie-Setup script or use RetroPie 3.5. 7 | 8 | # Steps 9 | 1. Either open the commandline on the pi by exiting emulationstation or ssh into it 10 | 11 | 2. Ensure your bluetooth adapter is setup correctly and working 12 | 13 | 3. Enter 'sudo bluetoothctl' command 14 | 15 | 4. The bluetooth control input should open, now type in the following commands in this order (you can use the TAB key to auto complete the mac address for the pair and connect command) 16 | ```shell 17 | power on 18 | agent on 19 | pairable on 20 | # not a command press the button on the controller 21 | scan on 22 | pair # note: we do not explicitly connect, we just pair! 23 | connect # there seems to be a pretty short timeout, so execute this immediately after the pairing command 24 | trust 25 | disconnect 26 | ``` 27 | Now you're done, press any button on the controller and it should connect, press the power button and it should disconnect, it also persists after a reboot 28 | 29 | # Lights 30 | There is a github project you can easily install that will light up the appropriate lights on your controllers based upon their order on your system. It's just a matter of running 2 commands on your pi. The project is found here: https://github.com/pyhammond/retropie_wiimote_lights -------------------------------------------------------------------------------- /docs/Configuration-Editor.md: -------------------------------------------------------------------------------- 1 | The configuration editor allows a user to edit the configurations for RetroPie and Retroarch from a gui interface. Many common settings are set up so that a user can change the settings with a gamepad. 2 | 3 | Manual configurations can also be set with the use of a keyboard. 4 | 5 | The Configuration Editor can be accessed from the RetroPie menu or through the [RetroPie Setup Script](Updating-RetroPie) and navigate to **Setup ▶ Configuration / tools ▶ configedit** 6 | 7 | When changing settings, there are notes at the bottom of the screen that explain each setting and what they do. 8 | 9 | ### Video Guide 10 | 11 | 12 | 13 | ### Basic Configuration 14 | 15 | ![basic options](https://cloud.githubusercontent.com/assets/10035308/14335301/6eade1ca-fc17-11e5-85dd-55e9d4264fae.PNG) 16 | ![basic options 2](https://cloud.githubusercontent.com/assets/10035308/14335297/6eab3bc8-fc17-11e5-8bf6-1230f67be4dc.PNG) 17 | ![basic options 3](https://cloud.githubusercontent.com/assets/10035308/14335298/6eac41da-fc17-11e5-8ffb-6ff208aedc31.PNG) 18 | 19 | ### Advanced Configuration 20 | 21 | ![advanced 1](https://cloud.githubusercontent.com/assets/10035308/14335300/6ead0dae-fc17-11e5-9330-f2e41f387036.PNG) 22 | ![advanced 2](https://cloud.githubusercontent.com/assets/10035308/14335302/6eb5cd2c-fc17-11e5-93a6-9689db057804.PNG) 23 | ![advanced 3](https://cloud.githubusercontent.com/assets/10035308/14335303/6eb89b9c-fc17-11e5-9631-7a64b5c53f41.PNG) 24 | ![advanced 4](https://cloud.githubusercontent.com/assets/10035308/14335299/6eacc308-fc17-11e5-8f52-cd86183ec21b.PNG) 25 | ![advanced 5](https://cloud.githubusercontent.com/assets/10035308/14335296/6ea96ac8-fc17-11e5-81d7-e737c7290e41.PNG) 26 | 27 | When making manual edits you'll press `tab` on the keyboard to exit out of the edit session. Whatever edits you have made will be saved when you exit the dialog gui. 28 | -------------------------------------------------------------------------------- /docs/Wii.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![wii](https://cloud.githubusercontent.com/assets/10035308/18609217/13ac9b3a-7cba-11e6-990b-bf983afafbbc.png) 3 | *** 4 | _The Wii is a home video game console that was released by Nintendo on November 19, 2006. It was the first console to successfully market motion controllers. After 7 years of production, the orginal console was discontinued in 2013. A scaled down version known as the Wii Mini remained in production until 2017._ 5 | *** 6 | 7 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 8 | | :---: | :---: | :---: | :---: | :---: | 9 | | [dolphin](https://github.com/dolphin-emu/dolphin.git) | wii | .iso | none | /opt/retropie/configs/wii/Config | 10 | 11 | > **Note This is only for x86 builds- Not the Raspberry Pi!.** 12 | 13 | ## Emulator: [dolphin](https://github.com/dolphin-emu/dolphin.git) 14 | 15 | ## ROMS 16 | 17 | Accepted File Extensions: **.iso** 18 | 19 | Place your Wii ROMs in 20 | ``` 21 | /home/pi/RetroPie/roms/wii 22 | ``` 23 | ## Controls 24 | 25 | Dolphin controls must currently be mapped via the GUI, accessed by launching **dolphin-gui** via [Runcommand](Runcommand). 26 | 27 | From there there graphical client will launch and you can bind your controller in the Dolphin Interface as well as change settings. 28 | 29 | ### Exiting 30 | 31 | To exit Dolphin via a keyboard use **Alt+F4** or additionally **Escape** available in **dolphin** (not **dolphin-gui**). 32 | 33 | To map a button on your controller to exit Dolphin you will need to launch via the gui method above. 34 | Once in the menu navigate to Hotkey Behavior. 35 | Switch the device indicator to your controller 36 | select the exit function and map a button like select to this function. 37 | You will also need to configure in the graphics window to always force window on top and to hide mouse/cursor 38 | 39 | Now enter back into emulationstation mode and launch a dolphin game from the gamecube menu 40 | press x when the game is starting 41 | Select **dolphin-gui** instead of dolphin as the runcommand default emulator. 42 | Launch game 43 | You will now be able to exit back to emulationstation with that button you mapped. 44 | -------------------------------------------------------------------------------- /docs/Virtual-Boy.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![virtualboy](https://cloud.githubusercontent.com/assets/10035308/12214017/8fcf5e08-b642-11e5-8ee6-7ee08f23c5c1.png) 3 | *** 4 | _The Virtual Boy was Nintendo's attempt at virtual reality in 1995 and it was a horrid commercial failure._ 5 | 6 | *** 7 | 8 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 9 | | :---: | :---: | :---: | :---: | :---: | 10 | | [lr-beetle-vb](https://github.com/libretro/beetle-vb-libretro) | virtualboy | .7z .vb .zip | none | /opt/retropie/configs/virtualboy/retroarch.cfg | 11 | 12 | ## Emulator: [lr-beetle-vb](https://github.com/libretro/beetle-vb-libretro) 13 | 14 | ## ROMS 15 | Accepted File Extension: **.7z .vb .zip** 16 | 17 | Place your Virtual Boy ROMs in 18 | ``` 19 | /home/pi/RetroPie/roms/virtualboy 20 | ``` 21 | 22 | ## Controls 23 | 24 | ### Game Specific Control Information 25 | 26 | If you have a limited input method such as an snes-style controller or handheld, then the spreadsheet below will help you figure out which games you will be able to play. 27 | 28 | [Virtual Boy - General Game Info](https://docs.google.com/spreadsheets/d/1Om4WsHFk7y5xyc2HMFH3IRUclgkRG4XSe452yiJbykk/edit?usp=sharing) 29 | 30 | >If you want to improve the spreadsheet, then request editing permission and you will be approved in a timely manner. 31 | 32 | ### lr-beetle-vb Controls 33 | 34 | lr-beetle-vb utilises Retroarch configurations 35 | 36 | Add custom retroarch controls to the retroarch.cfg file in 37 | ```shell 38 | /opt/retropie/configs/virtualboy/retroarch.cfg 39 | ``` 40 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) 41 | 42 | ![nintendo_virtualboy_diagram](https://cloud.githubusercontent.com/assets/10035308/16599637/7f382d3a-42c0-11e6-8e7d-bdbacf7afd82.png) 43 | 44 | ## Enabling Right D-Pad to Right Analog Stick 45 | 46 | Just go to the Options in the Quick Menu and enable "Right analog to digital". If the option isn't in the menu, then update lr-beetle-vb. 47 | 48 | For a closer replication of the Virtual Boy's unique dual d-pad input, you may also want to toggle the left d-pad to the left analog stick in Controls. -------------------------------------------------------------------------------- /docs/OpenTTD.md: -------------------------------------------------------------------------------- 1 | # OpenTTD 2 | 3 | ![](https://upload.wikimedia.org/wikipedia/commons/c/c5/Openttdlogo.svg) 4 | 5 | *** 6 | _OpenTTD is an OpenSource Port of Transport Tycoon Deluxe_ 7 | 8 | *** 9 | 10 | Official OpenTTD Wiki: [https://wiki.openttd.org/OpenTTD](https://wiki.openttd.org/OpenTTD) 11 | 12 | 13 | This emulator is **experimental** and can be installed from the optional menu of the [retropie setup script](Updating-RetroPie) 14 | 15 | ### Getting Started 16 | 17 | You will need a keyboard and a mouse - gamepads will not work for this game 18 | 19 | When you first start up the game you will be greeted by the following screen: 20 | 21 | ![missing_graphics2](https://cloud.githubusercontent.com/assets/10035308/11429299/65a3bbf0-9433-11e5-8f46-71163a4d4cf1.png) 22 | 23 | Download the graphics and then select check online content 24 | 25 | ![openingscreen3](https://cloud.githubusercontent.com/assets/10035308/11429300/65a6c19c-9433-11e5-976d-9db63e6cf3b3.png) 26 | 27 | If you don't have the original Transport Tycoon Deluxe files you'll want to at the very least download **OpenMSX** and **OpenSFX** packs so you have sound effects and music. 28 | 29 | ![graphics and sounds2](https://cloud.githubusercontent.com/assets/10035308/11429301/65a8e4a4-9433-11e5-928d-be56c9cd77a4.png) 30 | 31 | Once you've downloaded **OpenMSX** and **OpenSFX** you have to enable them in the game options as follows: 32 | 33 | ![gamesettings2](https://cloud.githubusercontent.com/assets/10035308/11429542/c4fa12d6-9436-11e5-9d5c-4b8049f2cf72.png) 34 | 35 | ![options2](https://cloud.githubusercontent.com/assets/10035308/11429541/c4f98212-9436-11e5-870b-905009401029.png) 36 | 37 | Then finally, in order to get your music playing you have to start a new game and turn on the jukebox: 38 | 39 | ![sounds4](https://cloud.githubusercontent.com/assets/10035308/11429543/c4faa84a-9436-11e5-8c0d-907ce61dad2c.png) 40 | 41 | _Optionally_, you can also download **zBase** for 32-bit HD graphics and change the Base graphics set in the game options to zBase instead of OpenGFX. 42 | 43 | For more information on how to play the game see the Official OpenTTD Wiki: [https://wiki.openttd.org/OpenTTD](https://wiki.openttd.org/OpenTTD) -------------------------------------------------------------------------------- /docs/GemRB.md: -------------------------------------------------------------------------------- 1 | 2 | *** 3 | 4 | ![gemrb logo](https://cloud.githubusercontent.com/assets/10035308/13519937/6ee15d5e-e199-11e5-933b-4b5d369fb618.png) 5 | 6 | *** 7 | _GemRB is a portable open-source implementation of Bioware's Infinity Engine. It is an engine for Baldur's Gate, Icewind Dale and Planescape._ 8 | *** 9 | 10 | ## Emulator [GemRB](https://github.com/gemrb/gemrb) 11 | 12 | 13 | 14 | ## Roms 15 | 16 | You need to have the original Baldur's Gate/ Icewind Dale/ or Planescape data in order to play. Place your game data in: 17 | 18 | #### Baldur's Gate 1 19 | 20 | ``` 21 | /home/pi/RetroPie/roms/ports/baldurs1 22 | ``` 23 | 24 | #### Baldur's Gate 2 25 | 26 | ``` 27 | /home/pi/RetroPie/roms/ports/baldurs2 28 | ``` 29 | 30 | #### Icewind 1 31 | 32 | ``` 33 | /home/pi/RetroPie/roms/ports/icewind1 34 | ``` 35 | 36 | #### Icewind 2 37 | 38 | ``` 39 | /home/pi/RetroPie/roms/ports/icewind2 40 | ``` 41 | 42 | #### Planescape 43 | 44 | ``` 45 | /home/pi/RetroPie/roms/ports/planescape 46 | ``` 47 | 48 | ## Configs 49 | 50 | Default configs are automagically configured with the install script but you can tweak them further if you like. 51 | 52 | #### Baldur's Gate 1 53 | 54 | ``` 55 | /opt/retropie/configs/ports/baldursgate1/GemRB.cfg 56 | ``` 57 | 58 | #### Baldur's Gate 2 59 | 60 | ``` 61 | /opt/retropie/configs/ports/baldursgate2/GemRB.cfg 62 | ``` 63 | 64 | #### Icewind 1 65 | 66 | ``` 67 | /opt/retropie/configs/ports/icewind1/GemRB.cfg 68 | ``` 69 | 70 | #### Icewind 2 71 | 72 | ``` 73 | /opt/retropie/configs/ports/icewind2/GemRB.cfg 74 | ``` 75 | 76 | #### Planescape 77 | 78 | ``` 79 | /opt/retropie/configs/ports/planescape/GemRB.cfg 80 | ``` 81 | 82 | 83 | ## Extra Configurations 84 | 85 | If you are using demo data some configs need to be manually changed, see more info [HERE](http://web.archive.org/web/20150331014917/http://www.raspians.com/Knowledgebase/gemrb-baldurs-gate-on-the-raspberry-pi/) -------------------------------------------------------------------------------- /docs/Cannonball.md: -------------------------------------------------------------------------------- 1 | ![](images/cannonball/logo.png) 2 | 3 | *** 4 | _Cannonball is a program which allows you to play an enhanced version of Yu Suzuki's seminal arcade racer - [OutRun](https://segaretro.org/OutRun) - on a variety of systems._ 5 | 6 | *** 7 | 8 | ### Port: [Cannonball](https://github.com/djyt/cannonball/wiki/Cannonball-Manual) 9 | 10 | ### Roms 11 | 12 | Place the OutRun Revision B MAME rom in 13 | ``` 14 | /home/pi/RetroPie/roms/ports/cannonball 15 | 16 | ``` 17 | ### Custom music 18 | Cannonball can play WAVs instead of using the inbuilt game music. 19 | 20 | Custom WAV files can be copied to `/home/pi/RetroPie/roms/ports/cannonball/music`, then enabled by editing the `config.xml` configuration file. Each track can be configured individually in the `custom_music` section, by specifying the _full_ path to the WAV file and toggling the `enable` flag: 21 | 22 | ``` xml 23 | 24 | 25 | 26 | MAGICAL SOUND SHOWER REMIX 27 | /home/pi/roms/ports/cannonball/music/track1.wav 28 | 29 | 30 | 31 | PASSING BREEZE REMIX 32 | /home/pi/roms/ports/cannonball/music/track2.wav 33 | 34 | 35 | 36 | SPLASH WAVE REMIX 37 | /home/pi/roms/ports/cannonball/music/track3.wav 38 | 39 | 40 | LAST WAVE REMIX 41 | /home/pi/roms/ports/cannonball/music/track4.wav 42 | 43 | 44 | ``` 45 | 46 | The `config.xml` file is located in `/opt/retropie/configs/ports/cannonball` or (via file shares) in `\\retropie\configs\ports\cannonball`. 47 | 48 | See [HERE](https://github.com/djyt/cannonball/blob/master/roms/roms.txt) for exact rom info. 49 | 50 | See [HERE](https://github.com/djyt/cannonball/wiki/Cannonball-Manual) for more complete documentation. 51 | -------------------------------------------------------------------------------- /docs/Neo-Geo-Pocket.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![ngp](https://cloud.githubusercontent.com/assets/10035308/12213430/3468ca7a-b635-11e5-8e99-21e91ceb2b74.png) 3 | *** 4 | The Neo Geo Pocket was a handheld video game system released by SNK in 1998. 5 | 6 | *** 7 | 8 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 9 | | :---: | :---: | :---: | :---: | :---: | 10 | | [lr-beetle-ngp](https://github.com/libretro/beetle-ngp-libretro.git) | ngp | .7z .ngp .zip | none | /opt/retropie/configs/ngp/retroarch.cfg | 11 | | [lr-fbneo](https://github.com/libretro/fbneo.git) | ngp | .7z .ngp .zip | ngp.zip | /opt/retropie/configs/ngp/retroarch.cfg | 12 | 13 | ## Emulators: [lr-beetle-ngp](https://github.com/libretro/beetle-ngp-libretro.git), [lr-fbneo](https://github.com/libretro/fbneo.git) 14 | 15 | ## ROMS 16 | Accepted File Extensions: **.7z .ngp .zip** 17 | 18 | Place your Neo Geo Pocket ROMs in 19 | ``` 20 | /home/pi/RetroPie/roms/ngp 21 | ``` 22 | 23 | NOTE: **lr-fbneo** expects the game roms to be in .zip/.7z archives named in a similar fashion to arcade romsets, so the filenames of the roms is important. Use a romset validation/building program like Clrmamepro or RomCenter to have the correct filenames, using the [FBNeo NeoGeo Pocket DAT](https://github.com/libretro/FBNeo/blob/master/dats/FinalBurn%20Neo%20(ClrMame%20Pro%20XML%2C%20NeoGeo%20Pocket%20Games%20only).dat) file and a No-Intro Neo Geo Pocket ROM collection. 24 | 25 | ## BIOS 26 | **lr-fbneo** needs a BIOS ROM (`ngp.zip`) in order to run Neo Geo Pocket ROMs. The file needs to contain the `SNK Neo-Geo Pocket BIOS (1998)(SNK)(en-ja).bin` ROM. Place the `ngp.zip` file in `/home/pi/RetroPie/BIOS/fbneo`. 27 | 28 | | Filename | No-Intro name | MD5 | CRC32 | 29 | | :--: | :--: | :--: | :--: | 30 | | ngp.zip | [BIOS] SNK Neo Geo Pocket (Japan, Europe).ngp | D87D876C4391935C9D48EF352A3FF02D | 6232DF8D | 31 | 32 | ## Controls 33 | Both emulators use Retroarch input configurations. 34 | 35 | Add custom retroarch controls to the retroarch.cfg file in 36 | ```shell 37 | /opt/retropie/configs/ngp/retroarch.cfg 38 | ``` 39 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) 40 | 41 | ![neogeopocketdiagram](https://cloud.githubusercontent.com/assets/10035308/8244887/0e06c54a-15e4-11e5-8f8f-28758d16c446.png) -------------------------------------------------------------------------------- /docs/PC-FX.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![pc-fx](https://retropie.org.uk/forum/assets/uploads/files/1498080299430-nec_pc-fx_logo.svg-resized.png) 3 | *** 4 | _PC-FX is a 32-bit home video game console by NEC Home Electronics released in Japan on December 23, 1994._ 5 | 6 | *** 7 | 8 | | Emulator | Rom Folder | Extensions | BIOS | Controller Config | 9 | | :---: | :---: | :---: | :---: | :---: | 10 | | [lr-beetle-pcfx](https://github.com/libretro/beetle-pcfx-libretro) | pcfx | .img .iso .ccd .cue | pcfx.rom | /opt/retropie/configs/pcfx/retroarch.cfg | 11 | 12 | ## Emulator: [lr-beetle-pcfx](https://github.com/libretro/beetle-pcfx-libretro) 13 | 14 | **NOTE:** this emulator is experimental and suffers from slowness and sound shuttering. Probably won't be coming out of experimental any time soon. It can be installed from the experimental menu of the [RetroPie-Setup Script](Updating-RetroPie#using-the-retropie-setup-script). 15 | 16 | ## ROMS 17 | 18 | Place your PC-FX ROMs in 19 | ``` 20 | /home/pi/RetroPie/roms/pcfx 21 | ``` 22 | 23 | ## BIOS 24 | 25 | The BIOS file is named **pcfx.rom** (all in lower-case) 26 | 27 | Place pcfx.rom in 28 | ``` 29 | /home/pi/RetroPie/BIOS 30 | ``` 31 | 32 | | md5sum | CRC32 | 33 | |--------------|--------------------| 34 | | 08e36edbea28a017f79f8d4f7ff9b6d7 | 76ffb97a | 35 | 36 | [How do I calculate the md5sum or CRC32 of a BIOS file?](FAQ#how-do-i-calculate-the-md5sum-or-crc32-of-a-bios-file) 37 | 38 | ## Controls 39 | 40 | lr-beetle-pcfx utilise Retroarch configurations 41 | 42 | Add custom retroarch controls to the retroarch.cfg file in 43 | ```shell 44 | /opt/retropie/configs/pcfx/retroarch.cfg 45 | ``` 46 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) 47 | 48 | ## PC-FX BIN/CUE Files 49 | 50 | It is important that the image file (usually `.bin`) and the CUE file (`.cue`) match. 51 | 52 | CUE files are just text files containing a description of the CD. If you have files named like: 53 | 54 | ~~~ 55 | Chip Chan Kick.bin 56 | Chip Chan Kick.cue 57 | ~~~ 58 | 59 | then ensure the first line of the CUE file contains: 60 | 61 | ~~~ 62 | FILE "Chip Chan Kick.bin" BINARY 63 | ~~~ 64 | 65 | ## Additional Documentation 66 | 67 | [Mednafen PC-FX Documentation](https://mednafen.github.io/documentation/pcfx.html) 68 | -------------------------------------------------------------------------------- /docs/OpenTyrian.md: -------------------------------------------------------------------------------- 1 | 2 | *** 3 | ![](https://raw.githubusercontent.com/wiki/opentyrian/opentyrian/opentyrian_torm.png) 4 | 5 | *** 6 | _OpenTyrian is a port of the DOS shoot-em-up Tyrian. Jason Emery generously gave the OpenTyrian developers a copy of the Tyrian 2.1 source code, which has since been ported from Turbo Pascal to C. The port uses SDL, making it easily cross-platform._ 7 | 8 | *** 9 | ## Emulator: [OpenTyrian](https://github.com/opentyrian/opentyrian/wiki) 10 | 11 | This emulator can be installed from the [Retropie Setup script](Updating-RetroPie#manage-packages) 12 | 13 | ## Controls: 14 | 15 | ``` 16 | ctrl-backspace -- kill OpenTyrian 17 | alt-enter -- fullscreen 18 | ctrl-f10 -- ungrab mouse 19 | 20 | arrow keys -- ship movement 21 | space -- fire weapons 22 | enter -- toggle rear weapon mode 23 | ctrl/alt -- fire left/right sidekick 24 | ``` 25 | 26 | ### Configuring Game Controllers 27 | 28 | You can configure controllers in-game by starting a game in any mode, episode or difficulty - it doesn't matter which. From the pre-game menu, choose `Options` and then `Joystick`. If you have a game controller plugged in, then you will see a screen as below with buttons and axes already assigned. 29 | 30 | ![opentyrian-joystick](https://cloud.githubusercontent.com/assets/8166945/21713337/6231b3ba-d3f1-11e6-870c-cb090ed45ce5.png) 31 | 32 | Bear in mind that the button and axes numbering in OpenTyrian is the number as reported by [jstest](RetroArch-Configuration#determining-button-values) +1. For example, button 0 on your controller will register as `BTN 1`. 33 | 34 | To re-configure, use the arrow keys on a keyboard to select an action, FIRE, CHANGE FIRE etc. Press ENTER on a keyboard to highlight and then the button on your game controller that you wish to map. Repeat for other buttons. 35 | 36 | To remove a default setting, press the relevant button for the action. For example, to remove the default setting of `BTN 1` for FIRE, navigate to FIRE with a keyboard, press ENTER and then press button 0 on your controller. 37 | 38 | The settings will be saved to a configuration file, `opentyrian.cfg`, in the `/opt/retropie/configs/ports/opentyrian` folder. It is possible to manually edit this file if you prefer, just remember to add one to the button or axis number as reported by jstest. 39 | -------------------------------------------------------------------------------- /docs/Neo-Geo-Pocket-Color.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![ngpc](https://cloud.githubusercontent.com/assets/10035308/12213463/93536f40-b635-11e5-81ef-e30de2236d00.png) 3 | *** 4 | The Neo Geo Pocket Color was a handheld video game system released by SNK in 1999. 5 | 6 | *** 7 | 8 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 9 | | :---: | :---: | :---: | :---: | :---: | 10 | | [lr-beetle-ngp](https://github.com/libretro/beetle-ngp-libretro.git) | ngpc | .7z .ngc .zip | none | /opt/retropie/configs/ngpc/retroarch.cfg | 11 | | [lr-fbneo](https://github.com/libretro/fbneo.git) | ngp | .7z .ngp .zip | ngp.zip | /opt/retropie/configs/ngp/retroarch.cfg | 12 | 13 | ## Emulators: [lr-beetle-ngp](https://github.com/libretro/beetle-ngp-libretro.git), [lr-fbneo](https://github.com/libretro/fbneo.git) 14 | 15 | ## ROMS 16 | Accept File Extensions: **.7z .ngc .zip** 17 | 18 | Place your Neo Geo Pocket Color ROMs in 19 | ``` 20 | /home/pi/RetroPie/roms/ngpc 21 | ``` 22 | 23 | NOTE: **lr-fbneo** expects the game roms to be in .zip/.7z archives named in a similar fashion to arcade romsets, so the filenames of the roms is important. Use a romset validation/building program like Clrmamepro or RomCenter to have the correct filenames, using the [FBNeo NeoGeo Pocket DAT](https://github.com/libretro/FBNeo/blob/master/dats/FinalBurn%20Neo%20(ClrMame%20Pro%20XML%2C%20NeoGeo%20Pocket%20Games%20only).dat) file and a No-Intro Neo Geo Pocket Color ROM collection. 24 | 25 | ## BIOS 26 | **lr-fbneo** needs a BIOS ROM (`ngp.zip`) in order to run Neo Geo Pocket ROMs. The file needs to contain the `SNK Neo-Geo Pocket Color BIOS (1999)(SNK)(en-ja).bin` ROM. Place the `ngp.zip` file in `/home/pi/RetroPie/BIOS/fbneo`. 27 | 28 | | Filename | No-Intro name | MD5 | CRC32 | 29 | | :--: | :--: | :--: | :--: | 30 | | ngp.zip | [BIOS] SNK Neo Geo Pocket Color (World) (En,Ja).ngp | 3655AACEBB43A963607D4CF821FC1301 | 6EEB6F40 | 31 | 32 | ## Controls 33 | 34 | Both emulators use Retroarch input configurations. 35 | 36 | Add custom retroarch controls to the retroarch.cfg file in 37 | ```shell 38 | /opt/retropie/configs/ngpc/retroarch.cfg 39 | ``` 40 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) 41 | 42 | ![neogeopocketdiagram](https://cloud.githubusercontent.com/assets/10035308/8244887/0e06c54a-15e4-11e5-8f8f-28758d16c446.png) -------------------------------------------------------------------------------- /docs/Video-Issues.md: -------------------------------------------------------------------------------- 1 | Setting in `/boot/config.txt` 2 | ``` 3 | hdmi_drive=2 4 | ``` 5 | seems to solve issues related to HDMI in some cases. 6 | 7 | 8 | #### Can't change Resolution 9 | If you have had to use 10 | 11 | ``` 12 | hdmi_safe=1 13 | ``` 14 | 15 | to make your pi display on your display, you will only be able to get 640x480 resolution. To fix this you need to use these settings to allow different resolutions. 16 | 17 | ``` 18 | hdmi_force_hotplug=1 19 | hdmi_drive=2 20 | ``` 21 | and then set 22 | ``` 23 | hdmi_group=1 24 | hdmi_mode=16 25 | ``` 26 | to force a resolution (those settings are for 1080p 60hz). More options can be found at: http://elinux.org/RPiconfig#Video_mode_options 27 | 28 | An example of a forced 4:3 ratio at 1024x768 29 | 30 | ``` 31 | hdmi_drive=2 32 | hdmi_force_hotplug=1 33 | hdmi_group=2 34 | hdmi_mode=16 35 | ``` 36 | 37 | #### Show and set the current video mode 38 | 39 | ***Note:** This guide is only for operating systems that use `tvservice` to change the video mode, e.g. Raspbian, Xbian, and OSMC.* 40 | 41 | `tvservice -s`will show the current video mode. Example: 42 | ``` 43 | tvservice -s 44 | state 0x12000a [HDMI DMT (51) RGB full 4:3], 1600x1200 @ 60.00Hz, progressive 45 | ``` 46 | The option `-m` will show the CEA (HDMI) and DMT (DVI) modes that are supported by the display device: 47 | ``` 48 | tvservice -m CEA 49 | tvservice -m DMT 50 | ``` 51 | The preferred mode that is listed as `(prefer)` can be set by the `-p` option: 52 | ``` 53 | tvservice -p 54 | ``` 55 | Any other mode has to be specified by its Group (CEA or DMT) and the mode number that was listed by the `-m` option. Example for the mode 1600x1200 @ 60.00Hz in the example above: 56 | ``` 57 | tvservice -e "DMT 51" 58 | Powering on HDMI with explicit settings (DMT mode 51) 59 | ``` 60 | 61 | #### Reset the frame buffer after changing the video mode 62 | 63 | After changing the video mode via `tvservice`, it may necessary to reset the frame buffer. This can be achieved by changing its colour depth to 8 and then back to 16: 64 | 65 | ``` 66 | fbset -depth 8 && fbset -depth 16 67 | ``` 68 | 69 | #### Switch the display off and on again 70 | 71 | The `-o` (off) option of `tvservice` disables the video output. It can be switched on again by either the `-p` (preferred) option or the `-e` (explicit) option, see above. Example: 72 | ``` 73 | tvservice -o 74 | Powering off HDMI 75 | tvservice -p 76 | Powering on HDMI with preferred settings 77 | ``` 78 | -------------------------------------------------------------------------------- /docs/Sharp-X68000.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![x68000](https://user-images.githubusercontent.com/22881403/29473948-549047ec-841f-11e7-9828-4160b39733be.png) 3 | *** 4 | _The Sharp X68000 was a Japan-only home computer released in 1987._ 5 | *** 6 | 7 | | Emulator | Rom Folder | Extension | BIOS Files | Controller Config | 8 | | :---: | :---: | :---: | :---: | :---: | 9 | | [lr-px68k](https://github.com/libretro/px68k-libretro/) | x68000 | .dim .hdf .hdm .2hd .d88 .m3u | iplrom.dat, cgrom.dat, iplrom30.dat (optional), iplromco.dat (optional), iplromxv.dat (optional) | /opt/retropie/configs/x68000/retroarch.cfg | 10 | 11 | ## Emulator: [lr-px68k](https://github.com/libretro/px68k-libretro/) 12 | This emulator must be installed from the experimental section in RetroPie Setup. 13 | 14 | Currently, MIDI/sound module capabilities are not supported in the emulator. 15 | 16 | ## ROMS 17 | 18 | Accepted File Extensions: **.dim .hdf .hdm .2hd .d88 .m3u** 19 | 20 | Place your X68000 ROMs in: 21 | ``` 22 | /home/pi/RetroPie/roms/x68000 23 | ``` 24 | 25 | ## BIOS 26 | 27 | lr-px68k only requires a single BIOS file (out of a selection of four) and a font file. Below is a list of all the BIOS files to choose from, plus the required font file: 28 | 29 | | BIOS File | CRC-32 | MD5 | File type | 30 | | :---: | :---: | :---: | :---: | 31 | | iplrom.dat | 72BDF532 | 7FD4CAABAC1D9169E289F0F7BBF71D8E | BIOS file | 32 | | cgrom.dat | 9F3195F1 | CB0A5CFCF7247A7EAB74BB2716260269 | Font file | 33 | | iplrom30.dat | E8F8FDAD | F373003710AB4322642F527F567E020A | BIOS file | 34 | | iplromco.dat | 6C7EF608 | CC78D4F4900F622BD6DE1AED7F52592F | BIOS file | 35 | | iplromxv.dat | 00EEB408 | 0617321DAA182C3F3D6F41FD02FB3275 | BIOS file | 36 | 37 | 38 | Place your BIOS files in: 39 | ``` 40 | /home/pi/RetroPie/BIOS/keropi 41 | ``` 42 | 43 | ## Controls 44 | 45 | lr-px68k utilises Retroarch configurations. 46 | 47 | Add custom retroarch controls to the retroarch.cfg file in: 48 | 49 | ``` 50 | /opt/retropie/configs/x68000/retroarch.cfg 51 | ``` 52 | 53 | For more information on custom RetroArch controls, see: [RetroArch Configuration](RetroArch-Configuration) 54 | 55 | ## Swapping Disks 56 | By default, when loaded through a .m3u file, lr-px68k places the first disk listed in Drive 0, and the second disk listed in Drive 1. 57 | 58 | To swap either drive, press F12 to access the PX68k menu, then select your drive. You'll then need to navigate to /home/pi/RetroPie/roms/x68000 and select the disk you want to use. 59 | -------------------------------------------------------------------------------- /docs/Game-Boy-Color.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![gbc](https://cloud.githubusercontent.com/assets/10035308/12191836/672b3014-b596-11e5-9bbe-bcafd30bb402.png) 3 | *** 4 | _The Game Boy Color was an 8 bit handheld gaming console released by Nintendo in 1998. Pokemon Yellow anyone?_ 5 | 6 | *** 7 | 8 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 9 | | :---: | :---: | :---: | :---: | :---: | 10 | | [lr-gambatte](https://github.com/libretro/gambatte-libretro) | gbc | .7z .gbc .zip | gbc_bios.bin (optional)| /opt/retropie/configs/gbc/retroarch.cfg | 11 | | [lr-tgbdual](https://github.com/libretro/tgbdual-libretro) | gbc | .7z .gbc .zip | none | /opt/retropie/configs/gb/retroarch.cfg | 12 | | [lr-mgba](https://github.com/libretro/mgba) | gbc | .7z .gb .zip | gbc_bios.bin (optional), sgb_bios.bin (optional) | /opt/retropie/configs/gbc/retroarch.cfg | 13 | 14 | ## Emulators: [lr-gambatte](https://github.com/libretro/gambatte-libretro), [lr-tgbdual](https://github.com/libretro/tgbdual-libretro), [lr-mgba](https://github.com/libretro/mgba) 15 | 16 | lr-gambatte is the preferred single-player emulator, while lr-tgbdual runs with two instances for either two-player link cable games or parallel play on the same system. 17 | 18 | lr-mgba is a modern emulator that aims to be fast and accurate, supports local cable games, external BIOS, Super Game Boy emulation, among many other features. It also emulates [Game Boy](Game-Boy) and [Game Boy Advance](Game-Boy-Advance). 19 | 20 | **NOTE**: Playing link cable games is similar to [Game Boy](Game-Boy#two-player-link-cable-games). 21 | 22 | ## ROMS 23 | 24 | Accepted File Extensions: **.7z .gbc .zip** 25 | 26 | Place your Game Boy Color ROMs in 27 | ``` 28 | /home/pi/RetroPie/roms/gbc 29 | ``` 30 | 31 | ## BIOS 32 | lr-gambatte can load external BIOS for Game Boy Color (**gbc_bios.bin**). 33 | lr-mgba can load external BIOS for Game Boy Color (**gbc_bios.bin**) and Super Game Boy (**sgb_bios.bin**). 34 | 35 | Place the BIOS files in 36 | ``` 37 | /home/pi/RetroPie/BIOS 38 | ``` 39 | 40 | | BIOS | MD5 Checksum | 41 | | :---: | :---: | 42 | | **gbc_bios.bin** | `dbfce9db9deaa2567f6a84fde55f9680` | 43 | | **sgb_bios.bin** | `d574d4f9c12f305074798f54c091a8b4` | 44 | 45 | ## Controls 46 | 47 | Both emulators utilise Retroarch configurations 48 | 49 | Add custom retroarch controls to the retroarch.cfg file in 50 | ```shell 51 | /opt/retropie/configs/gbc/retroarch.cfg 52 | ``` 53 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) 54 | 55 | ![gameboycolor](https://cloud.githubusercontent.com/assets/10035308/7334404/bd65e496-eb4e-11e4-82e6-78494534d305.png) 56 | -------------------------------------------------------------------------------- /docs/index.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![retropie_logo](https://cloud.githubusercontent.com/assets/10035308/21968193/e1670f2a-db46-11e6-8ff7-eb6d7188c9e7.png) 3 | *** 4 | | Latest Version | [**4.8**](https://retropie.org.uk/download/) | [Changelog](Changelogs) | 5 | |:---:|:---:|:---:| 6 | 7 | ## What is RetroPie? 8 | 9 | RetroPie allows you to turn your Raspberry Pi or PC into a retro-gaming machine. It builds upon Raspberry Pi OS (Raspbian), EmulationStation, RetroArch and many other projects to enable you to play your favourite Arcade, home-console, and classic PC games with the minimum set-up. For power users it also provides a large variety of configuration tools to customise the system as you want. 10 | 11 | RetroPie sits on top of a full OS, you can install it on an existing Raspbian, or start with the RetroPie SD image and add additional software later. It's up to you. 12 | 13 | ## What is an Emulator? 14 | 15 | An emulator is software that makes a computer behave like another computer, or in the case of RetroPie a computer that behaves like a video game console such as the Super Nintendo. The RetroPie SD image comes pre-installed with many different emulators. Additional emulators may be installed from within RetroPie. 16 | 17 | ![blue_console_shadow](https://cloud.githubusercontent.com/assets/10035308/22178094/cf801644-dfe2-11e6-8327-71a61d540d2f.png) 18 | 19 | ## What are ROMs? 20 | 21 | ROMs are digital versions of game cartridges. Loading up a ROM in an emulator is the equivalent of putting a cartridge in a game console. 22 | 23 | ROMs are copyrighted content and as such are not included with RetroPie. 24 | 25 | ![blue_cartridge_shadow](https://cloud.githubusercontent.com/assets/10035308/22178090/cf5cad76-dfe2-11e6-8c63-ec48cc4755f6.png) 26 | 27 | ## What is a BIOS? 28 | A BIOS is a small piece of software that tells hardware how to work. Many emulators emulate their system's BIOS, but others require you to supply a BIOS file. If a BIOS is required, the emulator's page will say so. 29 | 30 | BIOSs are also copyrighted and are therefore not included with RetroPie. 31 | 32 | ## Getting Started 33 | 34 | Select your system for installation instructions: 35 | 36 | |**[Raspberry Pi](First-Installation)** | **[PC](Debian)** | **[Odroid](Odroid-C1-C2)** | 37 | |:---:|:---:|:---:| 38 | |[![blue_rpi_shadow](https://cloud.githubusercontent.com/assets/10035308/22178093/cf7ecf00-dfe2-11e6-8fb3-dab3b1e17f7d.png)](First-Installation)|[![blue_pc_icon_shadow](https://cloud.githubusercontent.com/assets/10035308/22178091/cf7ebdf8-dfe2-11e6-9d19-f7bd06cc7751.png)](Debian)|[![blue_odroid_icon_shadow](https://cloud.githubusercontent.com/assets/10035308/22178092/cf7ec15e-dfe2-11e6-910a-44531acffffb.png)](Odroid-C1-C2)| 39 | 40 | -------------------------------------------------------------------------------- /docs/Adventure-Game-Studio.md: -------------------------------------------------------------------------------- 1 | *** 2 | 3 | ![Adventure Game Studio](https://www.adventuregamestudio.co.uk/images/bannerNew.png) 4 | 5 | *** 6 | _[Adventure Game Studio](https://www.adventuregamestudio.co.uk/) is an open source development tool that is primarily used to create graphic adventure games._ 7 | 8 | *** 9 | 10 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 11 | | :---: | :---: | :---: | :---: | :---: | 12 | | [AGS](https://github.com/adventuregamestudio/ags/tree/master/debian) | ags | .exe | none | mouse | 13 | 14 | 15 | 16 | ## ROMS 17 | Accepted File Extensions: **.exe** 18 | 19 | Place your AGS files in 20 | ``` 21 | /home/pi/RetroPie/roms/ags 22 | ``` 23 | 24 | ## Troubleshooting 25 | Ensure that you have RetroPie-Setup script version 4.3.8 or later before installing AGS, as several issues (such as content not appearing in EmulationStation and MIDI music playback) have been fixed. 26 | 27 | ## Video issues - window manager and graphics driver 28 | More recent Retropie images have not included a desktop or window manager as part of the image (including many Xorg libraries). It also does not automatically enable OpenGL drivers (which are still experimental). In contrast, when installing the AGS package it relies on Xorg as it uses xinit for display and it also defaults to using an OpenGL graphics driver (at least the last time I installed AGS this was the case). As a result the resolution was incorrect and performance was poor, both to the point where it was unusable. 29 | 30 | In order to rectify this I followed these steps: 31 | ### Install Pixel desktop environment 32 | After opening the Retropie setup script (either from the command line or via ES): Configuration / Tools -> Raspbian tools -> Install pixel desktop environment 33 | ### Modify AGS emulators.cfg file 34 | Edit the contents of /opt/retropie/configs/ags/emulators.cfg to contain: 35 | ``` 36 | ags = "xinit /opt/retropie/emulators/ags/bin/ags --fullscreen --gfxdriver software --gfxfilter hqx 1 %ROM%" 37 | default = "ags" 38 | ``` 39 | 40 | Note that the "--gfxfilter hqx 1" is not required and can be omitted if you prefer to have the non-filtered graphics. 41 | 42 | I elected to change the driver AGS was using rather than enable the OpenGL driver in Retropie as it is still experimental and is known to still cause issues for other emulators. I haven't actually tested AGS using the driver though so not sure if that works or not. 43 | 44 | ## Controls 45 | 46 | AGS requires a mouse attached to the Raspberry Pi. 47 | 48 | ## Useful Links 49 | 50 | * 51 | * 52 | * (in German) 53 | -------------------------------------------------------------------------------- /docs/RetroArch-Core-Options.md: -------------------------------------------------------------------------------- 1 | ## RetroArch Core Options 2 | 3 | RetroArch Cores (emulators) typically have options unique to them, known as Core Options. They are adjusted and stored in a different way to the general RetroArch configuration. 4 | 5 | ### Setting Core Options 6 | 7 | Whilst a ROM for the Core in question is running, enter the RGUI via holding Player 1's [Hotkey](Controller-Configuration#hotkey) combination **Hotkey+X**. This puts you in the **Quick Menu**. Navigate down to the **Core Options** sub-menu and press **RetroPad A** (typically the east action button) to enter the sub-menu. 8 | 9 | Within this sub-menu are all the options available to that Core. Depending on the Core used, the options could be organized under _Categories_, which group related options under a sub-menu. Navigate to the option that you want to change and press left and right to select the desired value or **RetroPad A** to open the list of available values and select from it. To apply, just close the RGUI/menu using the same Hotkey combination used to open it (**Hotkey+X**). 10 | 11 | /// tip | Note 12 | Some options will require you to restart the ROM to take effect, they're usually marked as such in the list of options. Core Options are saved automatically when you exit the ROM/close the emulator. 13 | /// 14 | 15 | ### Setting Core Options per-ROM 16 | 17 | You may prefer to apply Core Options to a specific ROM, and not for all ROMs within that core. To do so, follow the above instructions, but instead of exiting the RGUI at the end, select **Manage Core Options ▶ Save Game Options** at the top of the Options menu. This will create a Core Options `.opt` file specifically for that ROM within: 18 | 19 | ``` 20 | /opt/retropie/configs/all/retroarch/config/core 21 | ``` 22 | (where `core` is the name of the libretro Core) 23 | 24 | The file will be `ROMname.opt`. To remove the configuration, delete the file or use the **Manage Core Options** submenu to delete it. 25 | 26 | ### Core Options File 27 | 28 | The Core Options are stored in the following location 29 | ``` 30 | /opt/retropie/configs/all/retroarch-core-options.cfg 31 | ``` 32 | 33 | The file is populated with some defaults set by RetroPie during emulator installation, and the RetroArch cores will add the remaining Core Options with their own defaults. You should never need to add a new line to this file, as once a core is run, the Core Option's current setting will be added to the file. Example entries: 34 | 35 | ``` ini 36 | snes9x_aspect = "4:3" 37 | snes9x_audio_interpolation = "gaussian" 38 | snes9x_blargg = "disabled" 39 | snes9x_block_invalid_vram_access = "enabled" 40 | snes9x_echo_buffer_hack = "disabled" 41 | ``` 42 | 43 | Options are in the format `emulatorname_option_name = "value"` 44 | -------------------------------------------------------------------------------- /docs/Apple-II.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![apple2](https://cloud.githubusercontent.com/assets/10035308/12186640/04d5acd4-b562-11e5-946c-44b06c75ef3c.png) 3 | *** 4 | _The Apple II was a series of personal computers starting from 1977 to 1993._ 5 | *** 6 | 7 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 8 | | :---: | :---: | :---: | :---: | :---: | 9 | | [Linapple](http://sourceforge.net/projects/linapple/) | apple2 | .dsk | none | /opt/retropie/configs/apple2/linapple.conf | 10 | 11 | ## Emulator: [Linapple](http://sourceforge.net/projects/linapple/) 12 | 13 | ## ROMS 14 | Accepted File Extensions: **.dsk .nib .zip .DSK .NIB .ZIP** 15 | 16 | Place your Apple II disk image files in 17 | ```shell 18 | /home/pi/RetroPie/roms/apple2/ 19 | ``` 20 | ## Controls 21 | Upon boot, press F1 to get an overview of the controls, they will vary by game. As the Apple II was a personal computer it would only make sense that you would be using a keyboard and mouse. 22 | 23 | ```shell 24 | F1 - Show help screen 25 | F2 - Cold reset 26 | Shift+F2 - Reload conf file and restart 27 | F3, F4 - Choose an image file name for floppy disk in Slot 6 drive 1 or 2 respectively 28 | Shift+F3, Shift+F4 - The same thing for Apple hard disks (in Slot 7) 29 | Alt+F3,Alt+F4 - same as F3,F4 using FTP (see linapple.conf about configuring FTP accounts) 30 | Alt+Shift+F3, Alt+Shift+F4 - same as Shift+F3, Shift+F4 but using FTP account (see above) 31 | F5 - Swap drives for Slot 6 32 | F6 - Toggle fullscreen mode 33 | F7 - Reserved for Debugger! 34 | F8 - Save current screen as a .bmp file 35 | Shift+F8 - Save settings changeable in runtime in conf file 36 | F9 - Cycle through various video modes 37 | F10 - Quit emulator 38 | F11 - Save current state to file, Alt+F11 - quick save 39 | F12 - Reload it from file, Alt+F12 - quick load 40 | Ctrl+0..9 - fast load state snapshot with corresponding number, saved previously by 41 | Ctrl+Shift+0..9 - fast save snapshot to current snapshot directory with corresponding number 0..9 42 | Ctrl+F12 - Hot reset 43 | Pause - Pause emulator 44 | Scroll Lock - Toggle full speed 45 | 46 | Num pad keys: 47 | Grey + - Speed up emulator 48 | Grey - - Speed it down 49 | Grey * - Normal speed 50 | ``` 51 | 52 | **Getting Started** 53 | 54 | * Press F3 to choose your disk drive and navigate to where you placed your disk images in the apple2 roms folder. 55 | 56 | * Select your game by pressing Enter and then press F2 to reboot into the game you just selected, now you should be inside your game. Most games will have a splash screen with controls specific to that game. 57 | 58 | * To exit back to Emulationstation press F10. 59 | 60 | ## Running Disks From EmulationStation 61 | 62 | [http://blog.petrockblock.com/forums/topic/how-to-get-linapple-disk-images-running-from-emulation-station-in-retropie/](http://blog.petrockblock.com/forums/topic/how-to-get-linapple-disk-images-running-from-emulation-station-in-retropie/) -------------------------------------------------------------------------------- /docs/Famicom-Disk-System.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![fds_header](https://cloud.githubusercontent.com/assets/10035308/23090452/7af681b8-f553-11e6-8da8-73f7815941c7.png) 3 | *** 4 | The Family Computer Disk System a.k.a. Famicom Disk System was released in Japan in 1986. It is an add-on to the Famicom and used floppy disks. 5 | *** 6 | 7 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 8 | | :---: | :---: | :---: | :---: | :---: | 9 | | [lr-fceumm](https://github.com/libretro/libretro-fceumm) | fds | .7z .fds .nes .zip | disksys.rom | /opt/retropie/configs/fds/retroarch.cfg | 10 | | [lr-nestopia](https://github.com/libretro/nestopia) | fds | .7z .fds .nes .zip | disksys.rom | /opt/retropie/configs/fds/retroarch.cfg | 11 | | [lr-fbneo](https://github.com/libretro/fbneo) | fds | .7z .zip | fdsbios.zip (containing `disksys.rom`) | /opt/retropie/configs/fds/retroarch.cfg | 12 | 13 | ## Emulators: [lr-nestopia](https://github.com/libretro/nestopia), [lr-fceumm](https://github.com/libretro/libretro-fceumm), [lr-fbneo](https://github.com/libretro/FBNeo) 14 | 15 | ## ROMS 16 | 17 | Accepted File Extensions: **.7z .fds .nes .zip** 18 | 19 | Place your FDS Roms in 20 | ``` 21 | /home/pi/RetroPie/roms/fds 22 | ``` 23 | **NOTE**: [lr-fbneo](lr-fbneo) expects the game roms to be in `.zip`/`.7z` archives named in a similar fashion to arcade romsets, so the filenames of the roms is important. Use a romset validation/building program like Clrmamepro or RomCenter to have the correct filenames, with the [FBNeo FDS DAT file](https://github.com/libretro/FBNeo/blob/master/dats/FinalBurn%20Neo%20(ClrMame%20Pro%20XML%2C%20FDS%20Games%20only).dat) file and a No-Intro NES ROM collection to get the correct ROMset. 24 | 25 | ## BIOS 26 | 27 | FDS games require the **disksys.rom** bios file. Place the BIOS in: 28 | 29 | * `/home/pi/RetroPie/BIOS` for `lr-fceumm` and `lr-nestopia` 30 | * `/home/pi/RetroPie/BIOS` for `lr-fneo`, zipped in a file named `fdsbios.zip` 31 | 32 | | Filename | No-Intro name | MD5 | CRC32 | 33 | | :--: | :--: | :--: | :--: | 34 | | disksys.rom | [BIOS] Family Computer Disk System (Japan) (Rev 1) | ca30b50f880eb660a320674ed365ef7a | 5e607dcf | 35 | 36 | ## Controls 37 | 38 | Both emulators utilise RetroArch configurations. 39 | 40 | *Side Note*: In order to "switch to side B" of a ROM most controllers have this set to a default of the upper right bumper or right trigger button 41 | 42 | *Side Note*: Games that display **Ｂメンヲセットシテクダサ** are asking for the disk to be flipped to side B in order to continue. It is common for a game to display a title screen that asks for side B before the game can start. 43 | 44 | Add custom retroarch controls to the retroarch.cfg file in 45 | ```shell 46 | /opt/retropie/configs/fds/retroarch.cfg 47 | ``` 48 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) 49 | 50 | ![nesdiagram](https://cloud.githubusercontent.com/assets/10035308/8245062/4f0c5b8e-15e6-11e5-9255-b920543518d6.png) 51 | -------------------------------------------------------------------------------- /docs/3do.md: -------------------------------------------------------------------------------- 1 | *** 2 | 3 | ![3do right](https://cloud.githubusercontent.com/assets/10035308/12186059/8d7ec76a-b55c-11e5-9231-b0c561de271c.png) 4 | 5 | *** 6 | _The Panasonic 3do Real Multiplayer was a Home Video Game Console developed by the 3do company in 1994. Its humongous price tag of $700 and oversaturation in the video game market at the time meant it was a commercial failure._ 7 | 8 | *** 9 | 10 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 11 | | :---: | :---: | :---: | :---: | :---: | 12 | | [lr-opera](https://github.com/libretro/opera-libretro) | 3do | .chd .cue .iso .zip | panafz10.bin | /opt/retropie/configs/3do/retroarch.cfg | 13 | 14 | ## Emulator: [lr-opera](https://github.com/libretro/opera-libretro) (formerly known as `lr-4do`). 15 | 16 | **lr-opera** will be slow on the Pi3 and earlier models, however some games will run at playable speeds on the Pi4/Odroid-XU4/ 17 | 18 | ## ROMS 19 | Accepted File Extensions: **.iso** **.bin/cue** **.chd** **.zip** 20 | 21 | Place your 3do ROMs in 22 | ``` 23 | /home/pi/RetroPie/roms/3do 24 | ``` 25 | ## BIOS 26 | 27 | One of several BIOS ROMs must be placed in `/home/pi/RetroPie/BIOS`. The _norsa_ versions have the RSA encryption check disabled which should allow unsigned software to run. 28 | 29 | | Filename | Hash (MD5) | 30 | | ------------------------- | -------------------------------- | 31 | | panafz1.bin | f47264dd47fe30f73ab3c010015c155b | 32 | | panafz1j.bin | a496cfdded3da562759be3561317b605 | 33 | | panafz1j-norsa.bin | f6c71de7470d16abe4f71b1444883dc8 | 34 | | panafz10.bin | 51f2f43ae2f3508a14d9f56597e2d3ce | 35 | | panafz10-norsa.bin | 1477bda80dc33731a65468c1f5bcbee9 | 36 | | panafz10e-anvil.bin | a48e6746bd7edec0f40cff078f0bb19f | 37 | | panafz10e-anvil-norsa.bin | cf11bbb5a16d7af9875cca9de9a15e09 | 38 | | goldstar.bin | 8639fd5e549bd6238cfee79e3e749114 | 39 | | sanyotry.bin | 35fa1a1ebaaeea286dc5cd15487c13ea | 40 | | 3do_arcade_saot.bin | 8970fc987ab89a7f64da9f8a8c4333ff | 41 | 42 | For certain Japanese games a second "Kanji" ROM is necessary. 43 | 44 | | Filename | Hash (MD5) | 45 | | -------------------------- | -------------------------------- | 46 | | panafz1-kanji.bin | b8dc97f778a6245c58e064b0312e8281 | 47 | | panafz1j-kanji.bin | c23fb5d5e6bb1c240d02cf968972be37 | 48 | | panafz10ja-anvil-kanji.bin | 428577250f43edc902ea239c50d2240d | 49 | 50 | 51 | ## Controls 52 | 53 | lr-opera utilises Retroarch configurations 54 | 55 | Add custom retroarch controls to the retroarch.cfg file in 56 | 57 | ```shell 58 | /opt/retropie/configs/3do/retroarch.cfg 59 | ``` 60 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) 61 | 62 | ![goldstar_3do_diagram](https://cloud.githubusercontent.com/assets/10035308/16599643/7f450bd6-42c0-11e6-84d7-9cc0944e7b01.png) 63 | -------------------------------------------------------------------------------- /docs/PSP-FuSa-gamepad.md: -------------------------------------------------------------------------------- 1 | # PSP FuSa Gamepad 2 | 3 | With a custom firmware such as the pro CFW and ME CFW, and thanks to the natural flexibility of the PSP and the semi open hardware with the help of FuSa gamepad (a homebrew app for the PSP) you can get one of the best SNES gamepads for your Raspberry Pi 4 | 5 | ## What we need? 6 | 7 | * A **PSP** model 1xxx 2xxx or 3xxx (models 2xxx & 3xxx preferred) 8 | * A 1GB+ memory stick pro duo 9 | * A mini USB to USB A cable 10 | * A custom firmware 11 | * A PC or your Pi to transfer the files 12 | * The [FuSa gamepad](http://foosa.do.am/load/fusa_gamepad_version_03/3-1-0-33) app 13 | 14 | ## How to get started 15 | 16 | Downliad the FuSa gamepad zip and then turn your PSP on with your memory stick allready inside your console and if it is a model 3000 or Go run your CFW (older models do not need to run it because those models allready boots with the CFW loaded) plug your USB cable to your PSP and PC now uncompress your zip inside > /PSP/GAMES/ and safely unplug it from your PC, now run the app and connect it to your pi, the screen of your PSP should be turned off and the power light should stay on the final result is this one 17 | 18 | ![FuSa gamepad working](images/controllers/cUnEP0O.jpg) 19 | 20 | To configure it follow the RetroPie input configuration. 21 | 22 | ## FuSa with Kodi 23 | 24 | To make it work on kodi take your keyboard and go to settings > advanced > input and chose the gamepad configuration, inside that dialog go to the keys and push enter, now configure it at your style, do not press anything in the moments it asks for a key you do not have and a little suggestion I can do to be able to change the volume inside Kodi with your PSP's volume buttons is to configure the right stick, right stick up = volume +, right stick right = d-pad up (temporaly) right stick down = volume - and right stick left let the countdown go to zero, now go back to D-Pad up and set it again to D-Pad up, let the countdown reach zero in the next item and press ok 25 | 26 | ## Recommended layout 27 | 28 | For a consistent experience inside and outside Emulationstation includibg in Kodi and all the ReteoArch cores and because all the PS gamepads in Japan uses the same layout as a SNES gamepad but with different symbols I suggest use this buttons map plus my little suggestion for the volume buttons and the home button inside Kodi 29 | 30 | ![PSP layout](https://cloud.githubusercontent.com/assets/10035308/16599632/7f34c9ec-42c0-11e6-8988-0b2d6e795d10.png) 31 | 32 | ## Considerations 33 | 34 | - The PSP street is not supported 35 | - In FuSa gamepad the wireless switch works as an analogue stick switch 36 | - If your PSP is in a good condition, this is much better than a generic controller or a 360 gamepad. The buttons are really responsive and the D Pad ideal for retro gaming 37 | - The pi is NOT capable to fully charge a PSP 38 | - The volume buttons do not work in emulationstation or RetroArch 39 | - You can access to a more in depth configuration in the FuSa's ini files -------------------------------------------------------------------------------- /docs/Macintosh.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![macintosh](https://cloud.githubusercontent.com/assets/10035308/12192521/6b03d7d0-b59c-11e5-970e-b317595478bb.png) 3 | *** 4 | _The Apple Macintosh, later renamed the Macintosh 128K, was a personal computer released in 1984._ 5 | *** 6 | 7 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 8 | | :---: | :---: | :---: | :---: | :---: | 9 | | [BasiliskII](http://basilisk.cebix.net/) | macintosh | .img .rom | mac.rom, disk.img | hardcoded | 10 | | [MinivMac](http://www.gryphel.com/c/minivmac/) | macintosh | .dsk | vMac.ROM | hardcoded | 11 | 12 | ## Emulators: [BasiliskII](http://basilisk.cebix.net/), [MinivMac](http://www.gryphel.com/c/minivmac/) 13 | 14 | Mini vMac emulates the 68K processor macs (older software) e.g. Macintosh Plus, BasiliskII also emulates 68K but supports newer hardware as well e.g. Macintosh Classic, Macintosh II. 15 | 16 | ## BasiliskII 17 | 18 | ### ROMS 19 | Accepted File Extensions: **.img .rom (.dsk?, .sit?)** 20 | 21 | Place your Macintosh ROMs in 22 | ``` 23 | /home/pi/RetroPie/roms/macintosh 24 | ``` 25 | 26 | ### BIOS 27 | To start up your mac you need two main files: 28 | 29 | **mac.rom** (can be renamed from PERFORMA.ROM) 30 | 31 | **disk.img** (can be renamed from MacStartup.img) 32 | 33 | You will also place these files in 34 | ``` 35 | /home/pi/RetroPie/roms/macintosh 36 | ``` 37 | For more details see the forum post at https://blog.petrockblock.com/forums/topic/installing-basiliskii-an-early-macintosh-emulator/ and the links therein for detailed instructions about how to set up Basilisk II. 38 | 39 | If your **disk.img** file (from MacStartup.img) only has a few MB of free space on it while running the emulator, you must create a new larger one if you want more free space. Since the disk setup GUI is not included in RetroPie's version of Basilisk, you must install Basilisk on your PC to create a larger image and copy your disk.img file to it. Similar instructions can be found at 40 | https://www.emaculation.com/forum/viewtopic.php?f=6&t=8068 41 | 42 | Once you have a working disk image large enough to install other software on, you can access other install disk images from the "Unix" icon on the Mac desktop which can access the file system of the Raspberry Pi. 43 | 44 | ### Controls 45 | 46 | a keyboard and a mouse 47 | 48 | Ctrl + Escape will exit the emulator 49 | 50 | 51 | ## Mini vMac (Macintosh Plus) 52 | 53 | Place your Macintosh Plus ROMs in 54 | ``` 55 | /home/pi/RetroPie/roms/macintosh 56 | ``` 57 | 58 | ### ROMS 59 | 60 | Place your Macintosh Plus disks in 61 | 62 | ``` 63 | /home/pi/RetroPie/roms/macintosh 64 | ``` 65 | 66 | at minimum you'll need to include a Macintosh operating system file named **System Tools.dsk** as when choosing any dsk the launch script launches into the OS first by default. 67 | 68 | ### BIOS 69 | 70 | Place your **vMac.ROM** (Macintosh Plus Firmware) in 71 | 72 | ``` 73 | /home/pi/RetroPie/BIOS 74 | ``` 75 | 76 | ### Controls 77 | 78 | You'll want to shutdown from within the emulator to make sure to not corrupt your dsk and then you can use `Ctrl+Q` to exit the emulator. -------------------------------------------------------------------------------- /docs/Game-Gear.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![gamegear](https://cloud.githubusercontent.com/assets/10035308/12191611/0512b71e-b594-11e5-9d4e-47ed58354ef4.png) 3 | *** 4 | _The Sega Game Gear was an 8 bit handheld gaming console released in 1990_ 5 | 6 | *** 7 | 8 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 9 | | :---: | :---: | :---: | :---: | :---: | 10 | | [lr-genesis-plus-gx](https://github.com/libretro/Genesis-Plus-GX) | gamegear | .7z .bin .gg .sms .zip | bios.gg (optional)| /opt/retropie/configs/gamegear/retroarch.cfg | 11 | | [Osmose](https://github.com/RetroPie/osmose-rpi) | gamegear | .gg | none | /home/pi/osmose_files/osmose.ini | 12 | 13 | ## Emulators: [Osmose](https://github.com/RetroPie/osmose-rpi), [lr-genesis-plus-gx](https://github.com/libretro/Genesis-Plus-GX) 14 | The Osmose is tedious to configure controllers with. The lr-genesis-plus-gx will be the most convenient choice as it utilises RetroArch configurations. 15 | ## ROMS 16 | Acceptable File Extensions: **.7z .bin .gg .sms .zip** 17 | 18 | Place your Game Gear ROMs in 19 | ``` 20 | /home/pi/RetroPie/roms/gamegear 21 | ``` 22 | ## BIOS 23 | 24 | The file optional is **bios.gg** 25 | 26 | Place your bios.gg BIOS file in 27 | ``` 28 | /home/pi/RetroPie/BIOS 29 | ``` 30 | ## Controls 31 | 32 | ### lr-genesis-plus-gx 33 | 34 | lr-genesis-plus-gx utilises Retroarch configurations 35 | 36 | Add custom retroarch controls to the retroarch.cfg file in 37 | ```shell 38 | /opt/retropie/configs/gamegear/retroarch.cfg 39 | ``` 40 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) 41 | 42 | ![segagamegeardiagram](https://cloud.githubusercontent.com/assets/10035308/8245009/b4c87e72-15e5-11e5-8ee5-691daa4d1dd5.png) 43 | 44 | ### Osmose 45 | Once you have run Osmose at least once, a configuration file call osmose.ini will be created at 46 | ``` 47 | /home/pi/osmose_files/osmose.ini 48 | ``` 49 | It will look something like this: 50 | ```shell 51 | # Configuration Starts Here ! 52 | 53 | # 54 | # General emulation keys: 55 | # 56 | 57 | SCREENSHOT = SDLK_F2 58 | SOUNDSHOT = SDLK_F1 59 | QUIT = SDLK_ESCAPE 60 | TILESHOT = SDLK_F3 61 | DEBUGGER = SDLK_d 62 | PAUSE = SDLK_p 63 | 64 | # 65 | # First Player PAD: 66 | # 67 | 68 | PAD1_UP = SDLK_UP 69 | PAD1_DOWN = SDLK_DOWN 70 | PAD1_LEFT = SDLK_LEFT 71 | PAD1_RIGHT = SDLK_RIGHT 72 | PAD1_BUTTON_A = SDLK_LCTRL 73 | PAD1_BUTTON_B = SDLK_LALT 74 | 75 | # 76 | # Second Player PAD: 77 | # 78 | 79 | PAD2_UP = SDLK_KP5 80 | PAD2_DOWN = SDLK_KP2 81 | PAD2_LEFT = SDLK_KP1 82 | PAD2_RIGHT = SDLK_KP3 83 | PAD2_BUTTON_A = SDLK_n 84 | PAD2_BUTTON_B = SDLK_b 85 | ``` 86 | 87 | The above controls only apply to the keyboard. Configuring controls for a gamepad must be done by editing the es_systems.cfg file 88 | ``` 89 | /etc/emulationstation/es_systems.cfg 90 | ``` 91 | add your specific controls in this format to the gamegear section: 92 | ``` 93 | osmose -joy 1 -joy1 1 -joy2 2 -joyquit 6 94 | ``` 95 | see [This Thread](http://www.raspberrypi.org/forums/viewtopic.php?f=78&t=23550) for more details -------------------------------------------------------------------------------- /docs/Colecovision.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![](https://upload.wikimedia.org/wikipedia/en/thumb/9/9a/COLECO_VISION_LOGO.svg/782px-COLECO_VISION_LOGO.svg.png) 3 | *** 4 | _The Colecovision is a home video game console released by Coleco in 1982. It features a unique gamepad which is a mixture of a phone keypad and a joystick_ 5 | *** 6 | 7 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 8 | | :---: | :---: | :---: | :---: | :---: | 9 | | [CoolCV](http://atariage.com/forums/topic/240800-coolcv-emulator-for-mac-os-x-linux-windows-and-raspberry/page-1) | coleco | .bin .col .rom .zip | none (integrated) | /opt/retropie/configs/coleco/coolcv_mapping.txt | 10 | | [lr-blueMSX](https://github.com/libretro/blueMSX-libretro) | coleco | .bin .col .rom .zip | coleco.rom | /opt/retropie/configs/coleco/retroarch.cfg | 11 | 12 | ## Emulators [CoolCV](http://atariage.com/forums/topic/240800-coolcv-emulator-for-mac-os-x-linux-windows-and-raspberry/page-1), [lr-blueMSX](https://github.com/libretro/blueMSX-libretro) 13 | 14 | Note that CoolCV is only available for the Raspberry Pi currently, but it's not compatible with the Pi4/400 models. 15 | 16 | ## ROMS 17 | 18 | Accepted File Extensions: **.bin .col .rom .zip** 19 | 20 | Place your Colecovision ROMs in 21 | ``` 22 | /home/pi/RetroPie/roms/coleco 23 | ``` 24 | 25 | 26 | ### lr-blueMSX BIOS: 27 | 28 | lr-blueMSX requires the `coleco.rom` BIOS. Place your BIOS in: 29 | ``` 30 | /home/pi/RetroPie/BIOS/Machines/COL - ColecoVision/ 31 | ``` 32 | 33 | ### lr-blueMSX Controls 34 | 35 | lr-blueMSX utilises Retroarch configurations 36 | 37 | Add custom retroarch controls to the retroarch.cfg file in 38 | ```shell 39 | /opt/retropie/configs/coleco/retroarch.cfg 40 | ``` 41 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) 42 | 43 | ## CoolCV Controls 44 | 45 | Keyboard is the default controller. Press Right Shift + Enter to exit 46 | 47 | Mapping file is created after you've started the emulator once in `/home/pi/coolcv_mapping.txt` 48 | 49 | ``` 50 | ' CoolCV mappings for Colecovision controllers to keyboard and joystick 51 | up_1 key1073741906 52 | right_1 key1073741903 53 | down_1 key1073741905 54 | left_1 key1073741904 55 | left_button_1 key32 joy0_0 56 | right_button_1 key109 joy0_1 57 | button3_1 key1073741939 58 | button4_1 key1073741939 59 | key1_1 key49 60 | key2_1 key50 61 | key3_1 key51 62 | key4_1 key52 63 | key5_1 key53 64 | key6_1 key54 65 | key7_1 key55 66 | key8_1 key56 67 | key9_1 key57 68 | key*_1 key111 69 | key0_1 key48 70 | key#_1 key112 71 | up_2 key119 72 | right_2 key100 73 | down_2 key115 74 | left_2 key97 75 | left_button_2 key9 joy1_0 76 | right_button_2 key113 joy1_1 77 | button3_2 key1073741939 78 | button4_2 key1073741939 79 | key1_2 key114 80 | key2_2 key116 81 | key3_2 key121 82 | key4_2 key102 83 | key5_2 key103 84 | key6_2 key104 85 | key7_2 key118 86 | key8_2 key98 87 | key9_2 key110 88 | key*_2 key106 89 | key0_2 key107 90 | key#_2 key108 91 | key_save key1073741882 92 | key_restore key1073741883 93 | key_exit key1073741939 94 | key_pause key1073741884 95 | key_reset key8 96 | ``` 97 | 98 | 99 | -------------------------------------------------------------------------------- /docs/Love.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![](https://love2d.org/style/logo.png) 3 | *** 4 | _Löve is a 2d game engine programmed primarily in lua._ 5 | *** 6 | ## Emulator [Löve](https://bitbucket.org/rude/love/src) (Experimental) 7 | 8 | It only really works well on a Raspberry Pi 2. Games are programmed for different versions of Löve. RetroPie uses Love 11.1 and so it is likely a lot of games will not work because they have not been updated for version 11.1. See the section "Versions" below for step by step instruction how to install the older version 0.10.2 of Löve. 9 | 10 | ## ROMS 11 | 12 | Accepted File Extensions: **.love** 13 | 14 | Place your Löve games in 15 | 16 | ``` 17 | /home/pi/RetroPie/roms/love/ 18 | ``` 19 | 20 | Note that love games are basically .zip files with a .love extension instead of a .zip, so when building LÖVE files from repos, the files all need to be in the top level directory (especially main.lua) 21 | (If you are an advanced user you can edit these files to change things like the game resolution, gampad/keyboard mappings, or add gamepad support 22 | 23 | ## Controls 24 | 25 | Controls vary by game though most will need a keyboard. [**Mari0**](http://stabyourself.net/mari0/) (which is installed when you install Löve) has some support for gamepads but you still need to use a keyboard to navigate the menus. 26 | 27 | ## Display 28 | For display it is best to leave the video settings alone in the runcommand menu and just use the in game settings to scale it to 5. 29 | 30 | If the games you are playing are not scaled correctly and the in-game video options don't work (or don't exist) then adjust the resolution with the runcommand menu. 31 | 32 | ## Other Games 33 | 34 | * [Itch.io](https://itch.io/games/tag-love2d) games created with Löve 35 | 36 | ### Full gamepad support 37 | * [**Mr. Rescue**](http://tangramgames.dk/games/mrrescue/), download [here](https://github.com/SimonLarsen/mrrescue/releases/download/1.02e/mrrescue1.02e.love) 38 | 39 | * [**Duck Marines**](http://tangramgames.dk/games/duckmarines/), download [here](https://github.com/SimonLarsen/duckmarines/releases/download/v1.0c/duckmarines-1.0c.love") 40 | 41 | * [**Curse of the Arrow**](https://egordorichev.itch.io/curse-of-the-arrow/), download [here](https://egordorichev.itch.io/curse-of-the-arrow/purchase") 42 | 43 | ### Keyboard/Mouse Only 44 | 45 | * [**Sienna**](http://tangramgames.dk/games/sienna/), download [here](https://github.com/SimonLarsen/sienna/releases/download/v1.0d/sienna-1.0d.love) 46 | 47 | * [**90 Second Portraits**](http://tangramgames.dk/games/90secondportraits/), download [here](https://github.com/SimonLarsen/90-Second-Portraits/releases/download/1.01b/90secondportraits-1.01b.love) 48 | 49 | ## Versions 50 | 51 | The default behavior of RetroPie is to always install the latest version of Löve. Currently, this is v11. However, most games are written for v10. 52 | 53 | In order to get other games to work, it is necessary to install Löve v10, which is available as the `love-0.10.2` package from RetroPie-Setup. After installing it, use the [runcommand launch menu](Runcommand.md#runcommand-launch-menu) to choose the version of Löve required to run a game. -------------------------------------------------------------------------------- /docs/SDLPoP.md: -------------------------------------------------------------------------------- 1 | ![383-prince-of-persia-dos-front-cover](https://user-images.githubusercontent.com/31816814/138679982-79bf35c9-d57b-4dc3-9baa-5d360aba1ce7.jpg) 2 | 3 | *** 4 | _SDLPoP is an open source port of the classic game [Prince of Persia](https://www.mobygames.com/game/dos/prince-of-persia)._ 5 | 6 | *** 7 | 8 | 9 | ### Emulator: [SDLPoP](https://github.com/NagyD/SDLPoP) 10 | 11 | ### Controls: 12 | 13 | #### Controlling the kid 14 | - left: turn or run left 15 | - right: turn or run right 16 | - up: jump or climb up 17 | - down: crouch or climb down 18 | - shift: pick up things 19 | - shift+left/right: careful step 20 | - home or up+left: jump left 21 | - page up or up+right: jump right 22 | You can also use the numeric keypad. 23 | 24 | #### Gamepad equivalents 25 | - left/right = left/right 26 | - A = down 27 | - B = quit 28 | - X = shift 29 | - Y = up 30 | 31 | #### Controlling the game 32 | - Esc: pause game 33 | - Space: show time left 34 | - Ctrl-A: restart level 35 | - Ctrl-G: save game (on levels 3..13) 36 | - Ctrl-J: joystick mode (implemented by segrax) / gamepad mode (implemented by Norbert) 37 | - Ctrl-K: keyboard mode 38 | - Ctrl-R: return to intro 39 | - Ctrl-S: sound on/off 40 | - Ctrl-V: show version 41 | - Ctrl-Q: quit game 42 | - Ctrl-L: load game (when in the intro) 43 | - Alt-Enter: toggle fullscreen 44 | - F6: quicksave 45 | - F9: quickload 46 | 47 | #### Viewing or recording replays 48 | - Ctrl+Tab (in game): start or stop recording 49 | - Tab (on title screen): view/cycle through the saved replays in the SDLPoP directory 50 | 51 | #### Cheats 52 | _Note: Cheats only work if you start the game with the command line option: "megahit"_ 53 | 54 | - Shift-L: go to next level 55 | - c: show numbers of current and adjacent rooms 56 | - Shift-C: show numbers of diagonally adjacent rooms 57 | - -: less remaining time 58 | - +: more remaining time 59 | - r: resurrect kid 60 | - k: kill guard 61 | - Shift-I: flip screen upside-down 62 | - Shift-W: slow falling 63 | - h: look at room to the left 64 | - j: look at room to the right 65 | - u: look at room above 66 | - n: look at room below 67 | - Shift-B: toggle hiding of non-animated objects 68 | - Shift-S: Restore lost hit-point. (Like a small red potion.) 69 | - Shift-T: Give more hit-points. (Like a big red potion.) 70 | 71 | A nice way to start it from the menu is to make a new .sh file for it, so you can decide if you 72 | like starting it with cheats or without. Simply make an new `prince_with_cheats.sh` file in the folder 73 | `/home/pi/RetroPie/roms/ports` and let it change the directory to: `/opt/retropie/ports/sdlpop` 74 | before starting the game with `./prince megahit` 75 | 76 | #### Troubleshooting / Tweaking / Saving the game 77 | 78 | You can change the in-game behavior of this game in the following way: 79 | 80 | Go to the folder: `/opt/retropie/configs/ports/sdlpop` 81 | 82 | There should be an file called `SDLPoP.ini`. If not, copy the file `SDLPoP.ini.def` 83 | over it. When you open this file you can edit some of the configurations of the game, 84 | like from which level onward you are allowed to save the game (default = 3). 85 | There are many other tweaks possible, the file will explain itself. 86 | -------------------------------------------------------------------------------- /docs/Memory-Split.md: -------------------------------------------------------------------------------- 1 | 2 | Raspberry Pi systems use a shared memory architecture, allocating memory for GPU (2d, 3d and video) and CPU tasks. It is possible to manually set this allocation, however there is typically no reason to adjust it as the defaults are correct. As per the [official documentation](https://www.raspberrypi.org/documentation/computers/config_txt.html#memory-options): 3 | > Unlike GPUs found on x86 machines, where increasing memory can improve 3D performance, the architecture of the VideoCore means **there is no performance advantage from specifying values larger than is necessary, and in fact it can harm performance**. 4 | 5 | ## Adjusting the Memory Split 6 | 7 | //// warning | NOTE 8 | Please be mindful of the platform-specific notes below, before changing any settings. 9 | //// 10 | 11 | ![advanced](https://cloud.githubusercontent.com/assets/10035308/10713851/061f690e-7a93-11e5-9ed1-86981e7c9325.png) 12 | 13 | ![advanced2](https://cloud.githubusercontent.com/assets/10035308/10713853/290b82cc-7a93-11e5-92ec-0b94aaa60185.png) 14 | 15 | You can choose a split from 16/32/64/128/256 (the settings may be different depending on the version of Pi you have) 16 | 17 | ![gpu](https://cloud.githubusercontent.com/assets/10035308/10713855/53c539b8-7a93-11e5-9016-2117e8a890ad.png) 18 | 19 | ## Raspberry Pi 4 and later 20 | 21 | On the Raspberry Pi 4 and later models, the 3D component of the GPU has its own memory management unit (MMU), and does not use memory from the `gpu_mem` allocation. Instead memory is allocated dynamically within Linux. Increasing this amount will not help emulation and it's recommended that it's not increased from the defaults set by the OS/Firmware. 22 | 23 | ### Kodi 24 | 25 | Previously, the FKMS driver still utilised the memory split for certain media tasks, e.g., hardware video decoding for 4K (HEVC) video. If you have issues with 4K videos in Kodi, upgrade to the latest kernel/firmware, for example via _RetroPie-Setup -> Configuration / Tools -> raspbiantools -> Upgrade Raspbian packages_. 26 | 27 | ## Raspberry Pi 0-3 28 | 29 | If you don't use the RetroPie provided image, and you install using the [manual installation method](Manual-Installation), you have to adjust the memory split settings manually before installation to reserve at enough video memory for running Emulationstation without problems. The default values used by the RetroPie image are: 30 | ~~~~ 31 | gpu_mem_256=128 32 | gpu_mem_512=256 33 | gpu_mem_1024=256 34 | ~~~~ 35 | 36 | In order to ensure sensible memory splits across older Pi models, the RetroPie Pi image uses the `gpu_mem_256`, `gpu_mem_512` and `gpu_mem_1024` overrides, which apply to Pis with that amount of memory (for example, the Pi 2 has 1024MB memory, so will use the `gpu_mem_1024` setting). These settings **_override_** the `gpu_mem` setting, so if you still want to adjust the memory split, you will have to manually edit `/boot/config.txt` and adjust the relevant value, or delete the lines entirely. 37 | 38 | These defaults should be adequate, and you can test via observing the GPU memory usage whilst an emulator is running. A complex display of the GPU memory usage can be viewed with: 39 | ~~~ 40 | sudo vcdbg reloc 41 | ~~~ 42 | -------------------------------------------------------------------------------- /docs/PSP.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![psp](https://cloud.githubusercontent.com/assets/10035308/12213680/cebac73c-b639-11e5-84b5-13a5589b1dcd.png) 3 | *** 4 | _The PlayStation Portable or PSP is a handheld video game system released by Sony in 2004._ 5 | 6 | *** 7 | 8 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 9 | | :---: | :---: | :---: | :---: | :---: | 10 | | [ppsspp](https://github.com/hrydgard/ppsspp) | psp | .cso .iso .pbp | none | hardcoded | 11 | | [lr-ppsspp](https://github.com/libretro/ppsspp) | psp | .cso .iso .pbp | none | /opt/retropie/configs/psp/retroarch.cfg | 12 | 13 | ## Emulators: [lr-ppsspp](https://github.com/libretro/ppsspp), [ppsspp](https://github.com/hrydgard/ppsspp) 14 | Not available for the Raspberry Pi 1. lr-ppsspp has the convenience of retroarch controller configs, but standalone ppsspp has the best performance and compatibility. 15 | 16 | ## ROMS 17 | Accepted File Extensions: **.cso .iso .pbp** 18 | 19 | Place your PSP ROMs in 20 | ``` 21 | /home/pi/RetroPie/roms/psp 22 | ``` 23 | 24 | ## Controls 25 | 26 | ### lr-ppsspp 27 | 28 | lr-ppsspp use Retroarch configurations 29 | 30 | Add custom retroarch controls to the retroarch.cfg file in 31 | ```shell 32 | /opt/retropie/configs/psp/retroarch.cfg 33 | ``` 34 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) 35 | 36 | ![psp_diagram](https://cloud.githubusercontent.com/assets/10035308/16599632/7f34c9ec-42c0-11e6-8988-0b2d6e795d10.png) 37 | 38 | ### ppsspp 39 | 40 | Controls can be mapped from the main menu under Settings >> Controls >> Control Mapping . To access this, connect a keyboard and press Esc during a game. 41 | 42 | ## PPSSPP - Enhancements 43 | 44 | ### Performance 45 | From the [RetroPie Subreddit](https://www.reddit.com/r/RetroPie/comments/5jieuu/how_to_get_most_psp_games_to_run_beautifully/) 46 | 47 | > What I've done so far with a very noticeable difference is set frameskip to 2 (will probably increase this a bit) Turn on auto frameskip (will limit frame skipping to whatever you set for the previous value) then tick Prevent FPS from exceeding 60. 48 | > 49 | > After that you want to change rendering resolution to 2x1, this will make everything look better on bigger screens. 50 | > 51 | > Then you want to goto the audio menu and set Audio Latency to high. 52 | 53 | **This will cause numerous games to no longer work properly due to the renderer being changed to the error-prone "Buffered rendering" because of the "Auto frameskip" being turned on. "Frameskip" in general can cause black frames depending on if the chosen game runs at an odd or even framerate and the accompanying frameskip isn't set to a matching odd or even number.** 54 | 55 | Regardless, for the games this does work in, the results will be much smoother gameplay, though a sufficiently overclocked Raspberry Pi 3B/3B+ may also be required to achieve full speed emulation. 56 | 57 | ### Stuttering when streaming data from disc 58 | 59 | If you find the game stuttering in repeatable occasions when reading data from disc, changing Settings > System > I/O Timing Method to "Host" will alleviate those issues. Especially noticeable on OutRun 2006 when changing stages, or on the GTA games running from slower storage devices. -------------------------------------------------------------------------------- /docs/Netplay.md: -------------------------------------------------------------------------------- 1 | # Netplay 2 | 3 | Some RetroArch cores have netplay built-in which means that if you have some friends in a different place and still want to play games with them you can. 4 | 5 | There are a few stipulations that have to be met before you are able to utilise netplay: 6 | 7 | - You both need to be running the same version of RetroArch 8 | - You both need to be running the same emulator 9 | - You both need to have the same exact ROM 10 | 11 | ## Configuration 12 | 13 | So first things first- you need to set up your configurations for netplay: 14 | 15 | you can access the netplay configurations from the RetroPie menu in EmulationStation or from the setup script. 16 | 17 | One person needs to be the host, everyone else who tries to connect to the host will be clients 18 | 19 | ### Host 20 | 21 | If you will be acting as the host... 22 | 23 | - Set your Netplay Mode to host 24 | - Change Host IP Address to your IP address 25 | - Either go to your router settings and open the port 55435 for both TCP and UDP **or** change the TCP/UDP Port setting in RetroArch to one that's already open 26 | - Select a number for Delay Frames. If you are experiencing a very low fps, try increasing this number. 27 | - Pick a Nickname 28 | - When launching a ROM to use netplay you'll open up the [runcommand menu](Runcommand#runcommand-launch-menu) by pressing `A` (or any key/button on your keyboard/gamepad) as your ROM loads and then you'll select launch netplay. 29 | 30 | ![host](https://cloud.githubusercontent.com/assets/10035308/10062467/1c89bb58-6220-11e5-942b-7892d4b82050.png) 31 | 32 | Make sure to tell your friend: 33 | 34 | - Your IP Address 35 | - Your Open Port 36 | - Your Delay Frames Number 37 | - Your selected Core and ROM 38 | 39 | ### Client 40 | 41 | If you will be joining a game... 42 | 43 | - Set your Netplay Mode to Client 44 | - Set Spectator Mode Enable to OFF 45 | - Change Host IP Address to the IP Address your friend gave you 46 | - Change TCP/UDP Port to the number your friend gave you 47 | - Change Delay Frames to the number your friend gave you 48 | - Pick a Nickname 49 | - When launching a ROM to use netplay you'll open up the [runcommand launch menu](Runcommand) by pressing a button (or any key on your keyboard) as your ROM loads and then you'll select launch netplay 50 | 51 | ![client](https://cloud.githubusercontent.com/assets/10035308/10062468/2046ec02-6220-11e5-9d42-f58779986f93.png) 52 | 53 | Now if you and your friend successfully followed all of these steps, your game should load. If it didn't, try checking if you have the same ROM, the same core and if your host's port is really open. If everything fails, consider switching server and client roles. 54 | 55 | ## Windows 56 | 57 | If you are on a Windows PC you can set up the network settings from the RGUI: 58 | 59 | ![settings](https://cloud.githubusercontent.com/assets/10035308/10062550/d0d17d8a-6220-11e5-8325-461c0d712668.png) 60 | ![network](https://cloud.githubusercontent.com/assets/10035308/10062551/d0d3dd5a-6220-11e5-910f-824cc081b902.png) 61 | 62 | Note that the following are settings when running as a client: 63 | 64 | ![network3](https://cloud.githubusercontent.com/assets/10035308/10065131/9a09ef6c-623e-11e5-8b96-19c0254feb1a.png) 65 | 66 | If you want the PC to be the host change Netplay Client Enable to off. 67 | -------------------------------------------------------------------------------- /docs/Master-System.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![segamastersystem](https://cloud.githubusercontent.com/assets/10035308/12213057/27eba8a4-b62f-11e5-8757-e4b56fc07900.png) 3 | *** 4 | _The Sega Master System was a 4th generation video game console released by Sega in 1987._ 5 | *** 6 | 7 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 8 | | :---: | :---: | :---: | :---: | :---: | 9 | | [lr-picodrive](https://github.com/libretro/picodrive) | mastersystem | .7z .bin .sms .zip | none | /opt/retropie/configs/mastersystem/retroarch.cfg | 10 | | [lr-genesis-plus-gx](https://github.com/libretro/Genesis-Plus-GX) | mastersystem | .7z .bin .sms .zip | bios_E.sms (optional), bios_U.sms (optional), bios_J.sms (optional) | /opt/retropie/configs/mastersystem/retroarch.cfg | 11 | | [Osmose](https://github.com/RetroPie/osmose-rpi) | mastersystem | .sms | none | /home/pi/osmose_files/osmose.ini | 12 | 13 | ## Emulators: [Osmose](https://github.com/RetroPie/osmose-rpi), [lr-genesis-plus-gx](https://github.com/libretro/Genesis-Plus-GX), [lr-picodrive](https://github.com/libretro/picodrive) 14 | Osmose has it's own configurations whereas lr-Genesis-Plus-GX and lr-picodrive utilise RetroArch configurations 15 | 16 | ## ROMS 17 | 18 | Accepted File Extensions: **.7z .bin .sms .zip** 19 | 20 | Place your Master System ROMs in 21 | ``` 22 | /home/pi/RetroPie/roms/mastersystem 23 | ``` 24 | ## BIOS 25 | 26 | lr-genesis-plus-gx can load BIOS file: **bios_E.sms**, **bios_U.sms** and **bios_J.sms** 27 | 28 | Place your bios_E.sms, bios_U.sms and bios_J.sms BIOS file in 29 | ``` 30 | /home/pi/RetroPie/BIOS 31 | ``` 32 | ## Controls 33 | 34 | ### lr-picodrive and lr-genesis-plus-gx 35 | 36 | lr-picodrive and lr-genesis-plus-gx utilise RetroArch configurations 37 | 38 | Add custom retroarch controls to the retroarch.cfg file in 39 | 40 | ``` 41 | /opt/retropie/configs/mastersystem/retroarch.cfg 42 | ``` 43 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) 44 | 45 | ![mastersystem](https://cloud.githubusercontent.com/assets/10035308/7334954/59794038-eb60-11e4-989d-6367c1fda8ef.png) 46 | 47 | ### Osmose 48 | Once you have run Osmose at least once, a configuration file call osmose.ini will be created at 49 | ``` 50 | /home/pi/osmose_files/osmose.ini 51 | ``` 52 | It will look something like this: 53 | ```shell 54 | # Configuration Starts Here ! 55 | 56 | # 57 | # General emulation keys: 58 | # 59 | 60 | SCREENSHOT = SDLK_F2 61 | SOUNDSHOT = SDLK_F1 62 | QUIT = SDLK_ESCAPE 63 | TILESHOT = SDLK_F3 64 | DEBUGGER = SDLK_d 65 | PAUSE = SDLK_p 66 | 67 | # 68 | # First Player PAD: 69 | # 70 | 71 | PAD1_UP = SDLK_UP 72 | PAD1_DOWN = SDLK_DOWN 73 | PAD1_LEFT = SDLK_LEFT 74 | PAD1_RIGHT = SDLK_RIGHT 75 | PAD1_BUTTON_A = SDLK_LCTRL 76 | PAD1_BUTTON_B = SDLK_LALT 77 | 78 | # 79 | # Second Player PAD: 80 | # 81 | 82 | PAD2_UP = SDLK_KP5 83 | PAD2_DOWN = SDLK_KP2 84 | PAD2_LEFT = SDLK_KP1 85 | PAD2_RIGHT = SDLK_KP3 86 | PAD2_BUTTON_A = SDLK_n 87 | PAD2_BUTTON_B = SDLK_b 88 | ``` 89 | 90 | The above controls only apply to the keyboard. Configuring controls for a gamepad must be done by editing the es_systems.cfg file 91 | ``` 92 | /etc/emulationstation/es_systems.cfg 93 | ``` 94 | add your specific controls in this format to the gamegear section: 95 | ``` 96 | osmose -joy 1 -joy1 1 -joy2 2 -joyquit 6 97 | ``` 98 | see [This Thread](http://www.raspberrypi.org/forums/viewtopic.php?f=78&t=23550) for more details -------------------------------------------------------------------------------- /docs/Fairchild-ChannelF.md: -------------------------------------------------------------------------------- 1 | # Fairchild Channel F 2 | *** 3 | 4 | 5 | 6 | *** 7 | _The Fairchild Channel F (short for "Channel Fun") was the first videogame system to use a microprocessor and game cartridges. It was first released in 1976 with a price of $169.95 and was discontinued in 1983._ 8 | 9 | *** 10 | ## Emulators: [lr-fbneo](https://github.com/libretro/fbneo), [lr-freechaf](https://github.com/libretro/freechaf) 11 | 12 | 13 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 14 | | :---: | :---: | :---: | :---: | :---: | 15 | | [lr-FreeChaf](https://github.com/libretro/freechaf) | channelf | .bin .chf | sl31253.bin, sl31254.bin, sl90025.bin | /opt/retropie/configs/channelf/retroarch.cfg | 16 | | [lr-FBNeo](https://github.com/libretro/fbneo) | channelf | .zip .7z | channelf.zip | /opt/retropie/configs/channelf/retroarch.cfg | 17 | 18 | 19 | ## Roms 20 | 21 | Place your ChannelF ROMs in: 22 | ``` 23 | /home/pi/RetroPie/roms/channelf 24 | ``` 25 | 26 | **NOTE**: [lr-fbneo](lr-fbneo) expects the game roms to be in `.zip`/`.7z` archives named in a similar fashion to arcade romsets, so the filenames of the roms is important. Use a romset validation/building program like Clrmamepro or RomCenter to have the correct filenames, with the [FBNeo ChannelF DAT file](https://github.com/libretro/FBNeo/blob/master/dats/FinalBurn%20Neo%20(ClrMame%20Pro%20XML%2C%20Fairchild%20Channel%20F%20Games%20only).dat) file and a No-Intro ChannelF ROM collection to get the correct ROMset. 27 | 28 | More info is provided [here](https://docs.libretro.com/library/fbneo/#building-romsets-for-fbneo). 29 | 30 | ## BIOS 31 | 32 | Pleace your BIOS files in 33 | ``` 34 | /home/pi/RetroPie/BIOS 35 | ``` 36 | 37 | **lr-fbneo** requires a `channelf.zip` file. It can also be copied in a `fbneo` sub-folder under the main BIOS folder. 38 | 39 | | Filename | Description | MD5 | 40 | |---|---|---| 41 | | channelf.zip | ChannelF BIOS | 2f2f8de3827ae1faf2495e497ca95232 | 42 | 43 | **lr-freechaf** uses the following files 44 | 45 | | Filename | Description | MD5 | 46 | |---|---|---| 47 | | sl31253.bin | ChannelF BIOS (PSU 1) | ac9804d4c0e9d07e33472e3726ed15c3 | 48 | | sl31254.bin | ChannelF BIOS (PSU 2) | da98f4bb3242ab80d76629021bb27585 | 49 | | sl90025.bin | ChannelF II BIOS (PSU 1) (optional)| 95d339631d867c8f1d15a5f2ec26069d | 50 | 51 | If the ChannelF II BIOS is included, it will be used instead of `sl31253.bin` file. All games are compatible with both. 52 | 53 | ## Controls 54 | 55 | Both emulators utilise RetroArch configurations. 56 | 57 | ### FreeChaf 58 | 59 | Access to the console buttons is provided via an overlay. Pressing 'start' on either controller will display the console buttons. You can select a button by moving left and right and press the button with any of the face buttons (A, B, X, Y). Pressing 'start' a second time will hide the overlay. 60 | 61 | * **Console Overlay** - allows the user to view and select console buttons. 62 | * **Controller Swap** - Controller Swap swaps the player 1 and player 2 controllers. 63 | 64 | | FreeChaF Function | Retropad | 65 | | --- | --- | 66 | |Forward| D-Pad Up, Left-Analog Up| 67 | |Backward| D-Pad Down, Left-Analog Down| 68 | |Rotate Left | Y, L, Right-Analog Left | 69 | |Rotate Right | A, R, Right-Analog Right | 70 | |Pull Up | X, Right-Analog Up | 71 | |Push Down | B, Right-Analog Down | 72 | |Show/Hide Console Overlay | Start | 73 | |Controller Swap | Select | 74 | -------------------------------------------------------------------------------- /docs/Nintendo-DS.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![nds](https://cloud.githubusercontent.com/assets/10035308/12213354/eab79344-b633-11e5-805b-7d1a93fa44dd.png) 3 | *** 4 | The Nintendo DS is a handheld video game console that was released by Nintendo in 2004. The DS stands for Dual Screen. 5 | *** 6 | 7 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 8 | | :---: | :---: | :---: | :---: | :---: | 9 | | [DraStic](http://drastic-ds.com/) | nds | .nds .zip | nds_bios_arm7.bin (optional), nds_bios_arm9.bin (optional), nds_firmware.bin (optional) | /opt/retropie/configs/nds/drastic/config/drastic.cfg | 10 | | [lr-desmume](https://github.com/libretro/desmume) | nds | .nds .zip | bios7.bin (optional), bios9.bin (optional), firmware.bin (optional) | /opt/retropie/configs/nds/retroarch.cfg | 11 | | [lr-desmume-2015](https://github.com/libretro/desmume2015) | nds | .nds .bin .zip | bios7.bin (optional), bios9.bin (optional), firmware.bin (optional) | /opt/retropie/configs/nds/retroarch.cfg | 12 | 13 | ## Emulator: [DraStic](http://drastic-ds.com/) 14 | 15 | Note that while DraStic may run very well, it is currently experimental beta software. Any games that use the microphone will only create noise and will not use a real microphone, Also any games in "bookmode" (e.g Brain Training) will always play rotated at 90 degrees and cannot be rotated in Drastic. 16 | 17 | ## BIOS 18 | 19 | The default installation of DraStic includes simulated BIOS files that will work in most cases. Actual BIOS files (listed above) can be added to 20 | ``` 21 | /opt/retropie/configs/nds/drastic/system 22 | ``` 23 | 24 | ## ROMS 25 | Accepted File Extensions: **.nds .zip** 26 | 27 | Place your DS ROMs in 28 | ``` 29 | /home/pi/RetroPie/roms/nds 30 | ``` 31 | 32 | ## Controls 33 | 34 | ### DraStic Controls 35 | 36 | Add custom controls using the DraStic GUI (by pressing RIGHT ANALOG RIGHT or DOWN ANALOG RIGHT (in some case) or "m" key on the keyboard), or by editing 37 | ``` 38 | /opt/retropie/configs/nds/drastic/config/drastic.cfg 39 | ``` 40 | 41 | ## Emulator: [lr-desmume](https://github.com/libretro/desmume) and [lr-desmume2015](https://github.com/libretro/desmume2015) 42 | 43 | Note that lr-desmume is very experimental and lags quite a bit even with an overclocked Pi4. However a few games that do not heavily emphasize 3D graphics will run at playable speeds. 44 | 45 | ## BIOS 46 | 47 | lr-desmume/lr-desmume2015 can optionally load and use the NDS BIOS/Firmware files: **bios7.bin**, **bios9.bin** and **firmware.bin**. 48 | 49 | Place the files in 50 | ``` 51 | /home/pi/RetroPie/BIOS 52 | ``` 53 | 54 | | File | MD5 | 55 | | :---: | :---: | 56 | | firmware.bin (NDS Firmware) | 145eaef5bd3037cbc247c213bb3da1b3 | 57 | | bios7.bin (ARM7 BIOS) | df692a80a5b1bc90728bc3dfc76cd948 | 58 | | bios9.bin (ARM9 BIOS) | a392174eb3e572fed6447e956bde4b25 | 59 | 60 | For the BIOS/Firmware files to be used by the emulator, the core option _Use External BIOS/Firmware_ should be enabled. 61 | 62 | ## ROMS 63 | Accepted File Extensions: **.nds .bin .zip** 64 | 65 | Place your DS ROMs in 66 | ``` 67 | /home/pi/RetroPie/roms/nds 68 | ``` 69 | 70 | ## Controls 71 | 72 | ### lr-desmume(2015) Controls 73 | lr-desmume utilises Retroarch configurations 74 | 75 | Add custom retroarch controls to the retroarch.cfg file in 76 | ```shell 77 | /opt/retropie/configs/nds/retroarch.cfg 78 | ``` 79 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) 80 | 81 | ![nintendo_ds_diagram](https://cloud.githubusercontent.com/assets/10035308/16599645/7f549f56-42c0-11e6-88a8-3acda5287da3.png) 82 | -------------------------------------------------------------------------------- /docs/VideoPac-Odyssey-2.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![videopac](https://cloud.githubusercontent.com/assets/10035308/12212914/3db2135a-b62d-11e5-8bc8-314eef1f117f.png) 3 | ![odyssey2](https://cloud.githubusercontent.com/assets/10035308/12213667/802575ea-b639-11e5-837d-354e3f6be631.png) 4 | *** 5 | _The Magnavox Odyssey2 known in Europe as the Philips Videopac G7000 (and a bunch of other names a bunch of other places) is a home video game console released in 1978. One of the earliest gaming consoles, it is one of the least known today. Games are quite similar in detail to that of Atari 2600._ 6 | *** 7 | 8 | | Emulator | Rom Folder | Machine Type | Extension | BIOS | Controller Config | 9 | | :---: | :---: | :---: | :---: | :---: | :---: | 10 | | [lr-o2em](https://github.com/libretro/libretro-o2em) | videopac | Videopac / Odyssey 2 G7000 model | .bin | o2rom.bin | /opt/retropie/configs/videopac/retroarch.cfg | 11 | | [lr-o2em](https://github.com/libretro/libretro-o2em) | videopac | Videopac+ (french) G7000 model | .bin | c52.bin | /opt/retropie/configs/videopac/retroarch.cfg | 12 | | [lr-o2em](https://github.com/libretro/libretro-o2em) | videopac | Videopac+ (european) G7400 model | .bin | g7400.bin | /opt/retropie/configs/videopac/retroarch.cfg | 13 | | [lr-o2em](https://github.com/libretro/libretro-o2em) | videopac | Videopac+ (french) G7400 model | .bin | jopac.bin | /opt/retropie/configs/videopac/retroarch.cfg | 14 | 15 | ## Emulator: [lr-o2em](https://github.com/libretro/libretro-o2em) 16 | 17 | ## ROMS: 18 | 19 | Accepted File Extensions: **.bin** 20 | 21 | Place your ROMs here: 22 | ``` 23 | /home/pi/RetroPie/roms/videopac 24 | ``` 25 | 26 | ## BIOS 27 | 28 | The BIOS file required is **o2rom.bin** 29 | 30 | Place your BIOS in 31 | ``` 32 | /home/pi/RetroPie/BIOS 33 | ``` 34 | 35 | ### Voice support 36 | 37 | In order to emulator The Voice expansion module, additional voice samples need to be added to the `/home/pi/RetroPie/BIOS/voice` folder. There are two sets of voice samples: 38 | 39 | * `mainsamp.zip`, which contains the main voice samples 40 | * `sidsamp.zip`, which contains the samples used by the game _Sid the Spellbinder_. 41 | 42 | ## Controls 43 | 44 | Really it says it uses Retroarch configurations and some gamepads work but for almost all of your games you will need a keyboard. Typically you will press 1 to start a game- for people who grew up in the 70's controls might be more intuitive, but they can be tricky to figure out as they change for each game... 45 | 46 | lr-o2em utilises Retroarch configurations 47 | 48 | Add custom retroarch controls to the retroarch.cfg file in 49 | ```shell 50 | /opt/retropie/configs/videopac/retroarch.cfg 51 | ``` 52 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) 53 | 54 | ![philips_videopac](https://cloud.githubusercontent.com/assets/10035308/8192731/79eeaea2-142d-11e5-924d-9d284d280981.png) 55 | 56 | ### Switching Emulation Station to the Odyssey² logo: 57 | 58 | If you are from the United States it is likely that you had the Odyssey² rather than the Videopac. If you want EmulationStation to show the Odyssey² graphics instead of Videopac then you should create a file `/opt/retropie/configs/all/platforms.cfg` with the following contents (note this requires at least v4.1.6 of the RetroPie-Setup script). 59 | 60 | ``` 61 | videopac_theme="odyssey2" 62 | videopac_platform="odyssey2" 63 | ``` 64 | 65 | Once this is done, please update the currently installed Videopac emulator from RetroPie-Setup and Emulation Station will now use the Odyssey² logo. Scraping from within Emulation Station should also return Odyssey² artwork. 66 | -------------------------------------------------------------------------------- /docs/Duke-Nukem-3D.md: -------------------------------------------------------------------------------- 1 | ![](https://static.3drealms.com/media/game_logos/7ac8171e68e941dd9147d57d9803575d.png) 2 | *** 3 | _Duke Nukem 3D is a First Person Shooter game developed by 3D Realms in 1996._ 4 | 5 | ## Port: [Eduke32](http://www.eduke32.com/) 6 | 7 | ## Basic Installation 8 | 9 | The shareware port can be installed under RetroPie setup. Go to **Manage packages** > **Manage optional packages** and select **eduke32**. You can install from binary or from source. 10 | 11 | ## ROMs 12 | 13 | Shareware versions of **duke3d.grp** and **duke.rts** are provided via symlinks in 14 | ``` 15 | /home/pi/RetroPie/roms/ports/duke3d 16 | ``` 17 | The shareware files are physically located in a different directory, but if you just replace the links in the folder above with your full version game data, it should work. 18 | 19 | ### Installing Duke Nukem 3D Official Addons 20 | 21 | EDuke32 port installation can automatically setup launching entries for the official addons and the NAM mod. To use this method, copy each addon files to `ports/duke32/addons/`. 22 | 23 | 24 | |Addon | Mod `.grp` file |Location | 25 | |---|:---|:--| 26 | | Duke It Out in DC | `dukedc.grp` | `/home/pi/RetroPie/roms/ports/duke3d/addons/dc` | 27 | | Nuclear Winter | `nw.grp` | `/home/pi/RetroPie/roms/ports/duke3d/addons/nw` | 28 | | Duke Caribbean: Life's a Beach | `vacation.grp` | `/home/pi/RetroPie/roms/ports/duke3d/addons/vacation` | 29 | | NAM | `nam.grp`* | `/home/pi/RetroPie/roms/ports/duke3d/addons/nam` | 30 | 31 | * `NAM` requires copying the `GAME.CON` file and renaming it to `NAM.CON`, in addition to the main `.grp` file. 32 | 33 | After copying the files, install the `eduke32` package and addons launching entries will be added to the Ports system. As with all new games, EmulationStation must be restarted after the installation/re-installation for the new addon entries be picked up and displayed. 34 | 35 | ## Controls: 36 | 37 | Key | Action 38 | --- | --- 39 | W or NUMPAD 8 | Move Forward 40 | S or NUMPAD 2 | Move Backward 41 | Left or NUMPAD 4 | Turn Left 42 | Right or NUMPAD 6 | Turn Right 43 | ALT | Strafe 44 | Right CTRL or Left Click | Fire 45 | E | Open/Use 46 | Shift | Run 47 | Caps Lock | Autorun 48 | Space or / | Jump 49 | Left CTRL | Crouch 50 | PGUP or NUMPAD 9 | Look Up 51 | PGDN or NUMPAD 3 | Look Down 52 | INS or NUMPAD 0 | Look Left 53 | DEL or NUMPAD . | Look Right 54 | A | Strafe Left 55 | D | Strafe Right 56 | HOME or NUMPAD 7 | Aim Up 57 | END or NUMPAD 1 | Aim Down 58 | 0-9 | Weapons 59 | Enter | Inventory 60 | [ | Inventory Left 61 | ] | Inventory Right 62 | H | Holo Duke 63 | J | Jetpack 64 | N | Nightvision 65 | M | Medkit 66 | Backspace | Turnaround 67 | T | Send Message 68 | Tab | Map 69 | \- | Shrink Screen 70 | \+ | Enlarge Screen 71 | 5 | Center View 72 | Scroll Lock | Holster Weapon 73 | Y | Show Opponents Weapon 74 | F | Map Follow Mode 75 | K | See Co-op View 76 | U | Mouse Aiming 77 | I | Toggle Crosshair 78 | R | Steroids 79 | Q | Quick Kick 80 | " | Next Weapon 81 | : | Previous Weapon 82 | ` | Show Console 83 | F1 | Help 84 | F2 | Save 85 | F3 | Load 86 | F4 | Sound/Music 87 | F5 | Change Music 88 | F6 | Quicksave 89 | F7 | Chase View 90 | F8 | Messages 91 | F9 | Quickload 92 | F10 | Quit 93 | F11 | Brightness 94 | F12 | Save PCX 95 | ESC | Menu 96 | 97 | 98 | If you start EDuke32 and it is not recognizing your controller bring down the console and type: 99 | 100 | `in_joystick 1` 101 | 102 | For information on how to configure an XBox360 controller to work in eduke32, check out [this forum post](https://retropie.org.uk/forum/post/130059). 103 | -------------------------------------------------------------------------------- /docs/Descent.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![](https://www.dxx-rebirth.com/logo.png) 3 | *** 4 | _Descent and Descent 2 are first person shooter games that were developed in the 90's for PC. DXX-Rebirth is a Source Port of the Descent and Descent 2 Engines for Windows, Mac OS, Linux (most *NIX systems), offering OpenGL graphics and effects, advanced Multiplayer, many improvements and new features._ 5 | *** 6 | 7 | DXX-Rebirth is currently an experimental build that can be installed from the experimental menu of the setup script. It will build from the current [source](https://github.com/dxx-rebirth/dxx-rebirth). Build time may take up to 30 minutes or more. It may have some issues with sound. 8 | 9 | 10 | # Descent 1 11 | ![](http://upload.wikimedia.org/wikipedia/en/5/5f/Descent_cover.png) 12 | ### Emulator: [D1X-Rebirth](http://www.dxx-rebirth.com/) 13 | 14 | ## Game Files 15 | Add all of the core game files into the **descent1** folder 16 | ``` 17 | ~/RetroPie/roms/ports/descent1 18 | ``` 19 | Add all add-on mission files into the **missions** folder 20 | ``` 21 | ~/RetroPie/roms/ports/descent1/missions 22 | ``` 23 | All player profiles, game settings, and save files are located in the config folder 24 | ``` 25 | /opt/retropie/configs/descent1 26 | ``` 27 | which should be symbolic linked from 28 | ``` 29 | ~/.d1x-rebirth 30 | ``` 31 | Add all demo files into the **demos** folder 32 | ``` 33 | /opt/retropie/configs/descent1/demos 34 | ``` 35 | 36 | ## Controls 37 | Action | Key 38 | --- | --- 39 | Pitch Forward | Up or Numpad 8 40 | Pitch Backward | Down or Numpad 2 41 | Turn Left | Left or Numpad 4 42 | Turn Right | Right or Numpad 6 43 | Slide On | Left Alt 44 | Slide Left | Numpad 1 45 | Slide Right | Numpad 3 46 | Slide Up | Numpad - 47 | Slide Down | Numpad + 48 | Bank Left | Q or Numpad 7 49 | Bank Right | E or Numpad 9 50 | Cycle Primary | , 51 | Cycle Secondary | . 52 | Fire Primary | CTRL 53 | Fire Secondary | Space 54 | Fire Flare | F 55 | Drop Bomb | B 56 | Rear View | Right or Numpad 6 57 | Automap | TAB 58 | Accelerate | A 59 | Reverse | Z 60 | 61 | # Descent 2 62 | ![](https://upload.wikimedia.org/wikipedia/commons/thumb/c/c8/Descent_II_logo.svg/1280px-Descent_II_logo.svg.png) 63 | ### Emulator: [D2X-Rebirth](http://www.dxx-rebirth.com/) 64 | 65 | ## Game Files 66 | Add all of the core game files into the **descent2** folder 67 | ``` 68 | ~/RetroPie/roms/ports/descent2 69 | ``` 70 | Add all add-on mission files into the **missions** folder 71 | ``` 72 | ~/RetroPie/roms/ports/descent2/missions 73 | ``` 74 | All player profiles, game settings, and save files are located in the config folder 75 | ``` 76 | /opt/retropie/configs/descent2 77 | ``` 78 | which should be symbolic linked from 79 | ``` 80 | ~/.d2x-rebirth 81 | ``` 82 | Add all demo files into the **demos** folder 83 | ``` 84 | /opt/retropie/configs/descent2/demos 85 | ``` 86 | 87 | 88 | ## Controls 89 | Action | Key 90 | --- | --- 91 | Pitch Forward | Up or Numpad 8 92 | Pitch Backward | Down or Numpad 2 93 | Turn Left | Left or Numpad 4 94 | Turn Right | Right or Numpad 6 95 | Slide On | Left Alt 96 | Slide Left | Numpad 1 97 | Slide Right | Numpad 3 98 | Slide Up | Numpad - 99 | Slide Down | Numpad + 100 | Bank Left | Q or Numpad 7 101 | Bank Right | E or Numpad 9 102 | Cycle Primary | , 103 | Cycle Secondary | . 104 | Fire Primary | CTRL 105 | Fire Secondary | Space 106 | Fire Flare | F 107 | Drop Bomb | B 108 | Rear View | Right or Numpad 6 109 | Automap | TAB 110 | Accelerate | A 111 | Reverse | Z 112 | Afterburner | S 113 | Headlight | H 114 | Energy>Shield | T 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | -------------------------------------------------------------------------------- /docs/Cheats.md: -------------------------------------------------------------------------------- 1 | If you're like me, there are some games I could just never win as a kid. This guide will finally allow you to win! (albeit with a much lesser sense of satisfaction) 2 | 3 | ## Download Cheats 4 | 5 | As a preface cheats only work through libretro/retroarch so take note of the emulators you are using. 6 | 7 | You first need to open the RGUI. There are two ways of accessing the RGUI: 8 | 9 | - In the **RetroPie** menu of EmulationStation select **Retroarch** 10 | or 11 | - [Hotkey combination](Controller-Configuration#hotkey) **Hotkey+X** to open the RGUI from within a game 12 | 13 | If you haven't done so already, you'll need to enable the advanced settings by navigating to **Settings >> User Interface >> Show Advanced Settings**, then enabling the Online Updater in **Settings >> User Interface >> Menu Item Visibility** by turning ON the **Show 'Online Updater'** option. 14 | 15 | Next, navigate to **Online Updater >> Update Cheats** and this will download a set of preconfigured cheat files for many games into `/opt/retropie/configs/all/retroarch/cheats` 16 | 17 | ### Enable Cheats 18 | 19 | Now you can launch the game you want to finally win: 20 | 21 | Open the RGUI with [Hotkey combination](Controller-Configuration#hotkey) **Hotkey+X** 22 | 23 | Choose **Quick Menu >> Cheats >> Load Cheat File** 24 | 25 | Navigate to your game title and select it 26 | 27 | Then navigate to the cheat you want to enable and press left or right to toggle it on/off 28 | 29 | Select **Apply Cheat Changes** 30 | 31 | Then press **B** to go out of the cheat menu and **resume** your game. 32 | 33 | Your cheats should now be enabled 34 | 35 | ### Create Cheat Files 36 | 37 | You can create .cht files in `/opt/retropie/configs/all/retroarch/cheats//.cht` 38 | 39 | The following is a reference chart for the types of cheat codes for each system: 40 | 41 | | Console | Cheat type | Example code | 42 | |---|---|---| 43 | | Famicom / NES | Action Replay | 02A2:01 | 44 | | Famicom / NES | Game Genie | APEETPEY | 45 | | Game Boy | Game Genie | FA1-B9C-4C1 | 46 | | Game Boy (Color) | GameShark | 0101CEC1 | 47 | | Game Boy Advance | GameShark v3 | CD93194F 089CE0B4 | 48 | | Game Boy Advance | GameShark v1/v2 | A62B1D67 EB2D | 49 | | Game Gear | Action Replay | 00D3-C280 | 50 | | Mega Drive / Genesis | Action Replay | FFFE21:0032 | 51 | | Mega Drive / Genesis | Game Genie | NN8A-AADN | 52 | | N64 | GameShark | 8033B177 0015 | 53 | | NDS | Action Replay | 22085A50 00000001 | 54 | | Sega Master System | Action Replay | 00C0-2502 | 55 | | Super Famicom / SNES | Action Replay | 7E1490:FF | 56 | | Super Famicom / SNES | Game Genie | 14B4-6F07 | 57 | 58 | 59 | #### Cheat Code Example 60 | 61 | Filename: `Addams Family, The - Pugsley's Scavenger Hunt (USA, Europe) (Game Genie).cht` 62 | 63 | ``` 64 | cheats = 3 65 | 66 | cheat0_desc = "Infinite Health" 67 | cheat0_code = "009-15C" 68 | cheat0_enable = false 69 | 70 | cheat1_desc = "Start With 9 Lives" 71 | cheat1_code = "092-17F" 72 | cheat1_enable = false 73 | 74 | cheat2_desc = "Infinite Lives" 75 | cheat2_code = "004-27F" 76 | cheat2_enable = false 77 | ``` 78 | 79 | #### Multiline Cheat Codes 80 | 81 | The following is an example for a PSX game 82 | 83 | Filename: `Resident Evil 2.cht` 84 | 85 | ``` 86 | cheats = 2 87 | 88 | cheat0_desc = "Infinite Ammo Claire (1/2)" 89 | cheat0_code = "800D49F5+0063" 90 | cheat0_enable = "true" 91 | 92 | cheat1_desc = "Infinite Ammo Claire (2/2)" 93 | cheat1_code = "800D4A01+0063" 94 | cheat1_enable = "true" 95 | ``` 96 | 97 | #### Mame Cheats 98 | 99 | Mame has its own configurations for cheats. You can see a guide [HERE](lr-mame2003#cheats) 100 | -------------------------------------------------------------------------------- /docs/Transferring-Roms.md: -------------------------------------------------------------------------------- 1 | ROM stands for *Read Only Memory*. In a RetroPie context, ROMs are digital copies of games which can be run on emulators (software that mimics your old gaming consoles). There are many issues involving copyright laws regarding the usage of ROMs, so in order to preserve the integrity and longevity of the RetroPie project, the download locations of ROMs will not and cannot be added to the Wiki. That being said, in the search of your childhood - Google is your friend. 2 | 3 | ## Transferring ROMs 4 | 5 | There are three main methods of transferring ROMs: via USB stick, via SFTP, and via Windows (Samba) shares. 6 | 7 | ### USB stick 8 | 9 | 1. Ensure that the USB stick is formatted to FAT32 or exFAT, and that the SD card has enough free space to hold all ROMs 10 | 2. Create a folder called `retropie` on the USB stick 11 | 3. Plug it into the RetroPie system. If the USB stick has an activity light, wait for it to finish blinking, else wait a few minutes 12 | 4. Remove the USB stick and plug it into the computer containing the ROMs 13 | 5. Add the ROMs to the USB stick inside their respective folders within the `retropie/roms/$CONSOLE` folder, where $CONSOLE is the name of the target console, e.g. `snes` or `arcade`. 14 | 6. Plug it back into the RetroPie system. If the USB stick has an activity light, wait for it to finish blinking, else wait (with many GBs of ROMs, wait several hours) 15 | 8. Remove the USB stick. The ROMs have now been transferred from the USB to the RetroPie system's SD card 16 | 9. Refresh the game listing in EmulationStation by pressing F4, or press **Start** on your controller > **Quit** > **Restart EmulationStation** 17 | 10. The transferred games should now be visible within EmulationStation. If any are missing, return to step 6 18 | 19 | ### SFTP 20 | 21 | SFTP (Secure File Transfer Protocol) is a network protocol that allows you to securely transfer files over the internet or locally on the same network when both the PC and RetroPie system are connected to the same router via ethernet or wifi. 22 | 23 | SFTP/SSH connection instructions are available on the [SSH page](SSH). Once you've enabled SSH and connected to your chosen client, you can simply drop the files in the `~/RetroPie/roms/$CONSOLE` folder, where $CONSOLE is the name of the target console, e.g. `snes` or `arcade`. 24 | 25 | ### Samba-Shares 26 | 27 | [Samba](https://www.samba.org/samba/what_is_samba.html) is a software suite that allows you to access file systems over the network. Naturally both your PC and Pi will need to be connected to the same network via Ethernet or Wifi in order to successfully transfer your files. 28 | 29 | - On Windows, type `\\RETROPIE` into the computer folder. You can also replace RETROPIE with your Raspberry Pi's IP address 30 | 31 | ![samba](https://cloud.githubusercontent.com/assets/10035308/9141308/edee8b52-3cf4-11e5-8bf3-73f8c27f99fb.png) 32 | 33 | - On Mac OS X/macOS, open Finder, select "Go" menu and "Connect to Server". Type `smb://retropie` and hit "Connect". 34 | 35 | ### Manually copy files from USB-stick 36 | 37 | RetroPie version 3.0+ contains a file manager. It allows you to manually transfer files between USB-stick and Raspberry Pi SD card. The file manager can be run from 'RetroPie' EmulationStation menu > **File Manager**. A Midnight Commander file manager guide can be found [here](http://www.thegeekstuff.com/2008/10/midnight-commander-mc-guide-powerful-text-based-file-manager-for-unix/). Your USB-stick should be mounted in `/media/usb`. The directories for the ROM files are located in `~/RetroPie/roms/$CONSOLE` folder, where $CONSOLE is the name of the target console, e.g. `snes` or `arcade`. 38 | 39 | ## Alternative Methods of Accessing Games 40 | 41 | - [Running ROMs From a USB](Running-ROMs-from-a-USB-drive) 42 | - [Running ROMs From a Network Share](Running-ROMs-from-a-Network-Share) 43 | -------------------------------------------------------------------------------- /docs/Smaller-RetroArch-Screen.md: -------------------------------------------------------------------------------- 1 | ### Introduction 2 | 3 | Some people like to have their gameplay on a smaller area in the middle of the screen, rather than blown up to the full display resolution of their TV. 4 | 5 | This is especially true of handhelds like Game Boy and Game Boy Advance where the original resolution was so low that blowing these up to 1080p results in HUGE pixels. 6 | 7 | This tutorial covers making the display of a RetroArch libretro emulator smaller and centred on the screen. 8 | 9 | ### Determine Display Resolution 10 | 11 | If your TV is displaying at 1080p, the resolution is **1920x1080**. 12 | 13 | If your TV or monitor displays at another resolution, find that out and keep it in mind. 14 | 15 | You may wish to refer to the Wikipedia [Display resolution](https://en.wikipedia.org/wiki/Display_resolution) page. 16 | 17 | ### Determine Console Resolution 18 | 19 | Find the original resolution of the console by looking it up somewhere like Wikipedia. Here are a few popular resolutions: 20 | 21 | * GBA: **240x160** 22 | * Game Boy: **160x144** 23 | * Game Gear: **160x144** 24 | * Neo Geo Pocket: **160x152** 25 | * Atari Lynx: **160x102** 26 | * WonderSwan: **224x144** 27 | 28 | Later home consoles (SNES, Master System, Mega Drive) often had multiple display resolutions and are not covered by this article. 29 | 30 | ### Multiply Console Resolution 31 | 32 | Take the original console resolution and multiply both numbers by the same amount to get a larger gameplay resolution which is still in the same aspect ratio and fits within your actual display resolution. 33 | 34 | It is best to multiply by a whole number (eg: 2, 3, 4) so the original pixels get sized up consistently. Multiplying by fractions (eg: 2.66, 3.75, 4.4) may end up with strange ugly pixel effects, especially if using shaders which apply scanlines or similar effects. 35 | 36 | For example, the GBA resolution was **240x160** so we'll multiply those up by **3** to land on **720x480**. An image of this size fits within a 1920x1080 display, is smaller than the full 1920x1080 display, and is still in the same aspect ratio so the game won't look stretched. 37 | 38 | ### Centre Image 39 | 40 | Now we've determined our actual display resolution, and the resolution we want the game shown at, we need to centre the image on screen. 41 | 42 | To do this, we take the **(original resolution - console resolution) / 2**. 43 | 44 | Following our example of a **1920x1080** screen showing a **720x480** GBA image, do the following: 45 | 46 | **(1920 - 720) / 2 = 600** is how far to offset horizontally. 47 | 48 | **(1080 - 480) / 2 = 300** is how far to offset vertically. 49 | 50 | ### Edit Configuration File 51 | 52 | Look at the console-specific page in the sidebar of this wiki and note where the system's configuration file. 53 | 54 | For example, the GBA config file is `/opt/retropie/configs/gba/retroarch.cfg` so any changes made in there will apply only to GBA games, not to other systems. 55 | 56 | Now add the following above the `#include` line in that file: 57 | 58 | ~~~ 59 | # 20 = Config, 21 = 1:1 PAR, 22 = Core Provided, 23 = Custom Viewport 60 | aspect_ratio_index = "23" 61 | 62 | # these two define the pixel size of the emulated screen 63 | # keep this in the same ratio as the original console 64 | # eg: GBA 240x160 * 3 = 720 x 480 65 | custom_viewport_width = "720" 66 | custom_viewport_height = "480" 67 | 68 | # the following two decide how far from the left and top the game screen is shown 69 | # to centre the game display use your original resolution, minus the screen size, divided by two 70 | # this example for 1080p screen (1920x1080) 71 | # (1920 - 720) / 2 = 600 72 | custom_viewport_x = "600" 73 | # (1080 - 480) / 2 = 300 74 | custom_viewport_y = "300" 75 | ~~~ 76 | 77 | Now when the desired console is started, the game should display in a smaller area in the middle of the screen. -------------------------------------------------------------------------------- /docs/Controller-Configuration.md: -------------------------------------------------------------------------------- 1 | RetroPie supports many popular controllers out of the box. On first boot you will be prompted to configure a controller in EmulationStation. Once you finish configuring your controller, multiple configuration profiles will be automagically generated for most of the systems in RetroPie. 2 | 3 | Some emulators will still require manual controller configuration which will be detailed on their respective system page here in the documentation. 4 | 5 | You can also configure controls for individual systems and individual games. For more advanced controller configuration with libretro cores (any emulator that starts with `lr`) see the [RetroArch-Configuration](https://retropie.org.uk/docs/RetroArch-Configuration/) page. 6 | 7 | /// note | Note 8 | Some controllers (primarily wireless or Bluetooth controllers) may require special drivers to be installed through the RetroPie Setup Script. They are detailed on their individual controller page. 9 | /// 10 | 11 | ## Controller Configuration 12 | 13 | On first boot this menu in EmulationStation will configure your controls for both Emulationstation and RetroArch Emulators: 14 | 15 | ![welcomescreen](https://cloud.githubusercontent.com/assets/10035308/9140482/cf42f25c-3cee-11e5-8f91-c1fc1c57175c.png) 16 | 17 | Hold down any button on your keyboard or gamepad and the name will appear at the bottom and then open up into a configuration menu: 18 | 19 | ![welcomescreengamepadname](https://cloud.githubusercontent.com/assets/10035308/9140505/f5c19e38-3cee-11e5-965e-0e4e85ddaf56.png) 20 | 21 | Follow the onscreen instructions to configure your gamepad- if you run out of buttons just hold down a button to skip each unused button. **When you get to OK press the button you have configured as "A"**. 22 | 23 | ![welcomescreengamepadconfigure](https://cloud.githubusercontent.com/assets/10035308/9140518/0263b9c8-3cef-11e5-922f-42f790f3be91.png) 24 | 25 | If you wish to configure more than one controller, you can do so from the start menu of emulationstation. For more details on manual controller configurations see this page [Here](RetroArch-Configuration). 26 | 27 | See the following diagrams for reference: 28 | 29 | | SNES Controller | 30 | |:---:| 31 | |![snes_controller](https://cloud.githubusercontent.com/assets/10035308/22185414/f129dc28-e099-11e6-8524-93facf275eda.png)| 32 | 33 | | XBox 360 Controller | 34 | |:---:| 35 | |![xbox360_controller](https://cloud.githubusercontent.com/assets/10035308/22185415/f12ff342-e099-11e6-8adb-d18e9c638e94.png)| 36 | 37 | | PS3 Controller | 38 | |:---:| 39 | |![ps3_controller](https://cloud.githubusercontent.com/assets/10035308/22185413/f10f27de-e099-11e6-97a4-ecbbc82c9e46.png)| 40 | 41 | ### Hotkey 42 | 43 | The Hotkey button enables you to press it in combination with another button to access functions such as saving, loading, and exiting in emulators. It is suggested to use the **Select** button as the hotkey. The following chart shows the default hotkey combinations. For example, if you chose Select as your Hotkey, that means you hold down Select while pressing the other button to execute the command. 44 | 45 | /// tip | Hotkey usage 46 | * Hotkey buttons/keys combinations are specific to the Retroarch/libretro based emulators. 47 | * The Hotkey enabled actions are enabled **only** for the 1st connected controller, the one that RetroArch considers to be _P1_ (player 1). Additional connected controllers (_P2_, _P3_, etc.) will not be able to trigger the combo actions. 48 | /// 49 | 50 | 51 | 52 | |Hotkey Combination | Action| 53 | | :---: | :---: | 54 | | Hotkey+Start | Exit | 55 | | Hotkey+Right Shoulder | Save | 56 | | Hotkey+Left Shoulder | Load | 57 | | Hotkey+Right | Input State Slot Increase | 58 | | Hotkey+Left | Input State Slot Decrease | 59 | | Hotkey+X | RGUI Menu | 60 | | Hotkey+B | Reset | 61 | 62 | For more information, see [Hotkeys](RetroArch-Configuration#hotkeys) 63 | -------------------------------------------------------------------------------- /docs/Virtual-Gamepad.md: -------------------------------------------------------------------------------- 1 | ![Virtual Gamepad](https://github.com/miroof/node-virtual-gamepads/raw/resources/screenshots/standalone.png?raw=true) 2 | *** 3 | _This project is the result of hard work from Miroof. https://github.com/miroof/node-virtual-gamepads_ 4 | *** 5 | 6 | Install from the experimental menu of the setup script (may only work well with a rpi2) 7 | 8 | ## Usage 9 | 10 | Once the nodejs application is launched, you just have to plug your gamepad controller by connecting your device on the same local network and by reaching the address _http://node_server_adress_ (i.e. your Raspberry Pi's IP address) on your choice of web browser (Chrome Mobile is recommended). 11 | 12 | ## Use it as a Smartphone Application (Chrome for Android) 13 | 14 | **Note** you need to configure the virtual gamepad from EmulationStation while in the web browser first _BEFORE_ you create the application on your smartphone otherwise the input configuration in emulationstation will not work.* 15 | 16 | With the add to homescreen Chrome feature, you can easily use virtual gamepads application without launching the browser each time you want to play. 17 | 18 | With only 3 clicks, virtual gamepads web application becomes a standalone application. 19 | 20 | ![](https://github.com/miroof/node-virtual-gamepads/raw/resources/screenshots/standalone_step1.png?raw=true) | ![](https://github.com/miroof/node-virtual-gamepads/raw/resources/screenshots/standalone_step2.png?raw=true) 21 | 22 | Then a shortcut is added on your homescreen and the application will be launched outside the browser. 23 | 24 | ![](https://github.com/miroof/node-virtual-gamepads/raw/resources/screenshots/standalone_step3.png?raw=true) | ![](https://github.com/miroof/node-virtual-gamepads/raw/resources/screenshots/standalone_step4.png?raw=true) 25 | 26 | ## Enjoy Haptic Feedbacks 27 | 28 | Because it's difficult to spot the right place in a touch screen without looking at it, the touch zone of each button was increased. LT button was moved at the center of the screen to let as much space as possible for the joystick and avoid touch mistakes. 29 | 30 | ![Virtual Gamepad Layout](https://github.com/miroof/node-virtual-gamepads/raw/resources/schemas/touch_zones.png?raw=true) 31 | 32 | To know if we pressed a button with success, the web application provides an haptic feedback which can be easily deactivated by turning off the vibrations of the phone. 33 | 34 | **You will need to configure your controller with EmulationStation and RetroArch just like you would any other controller.** 35 | 36 | ### Enable Virtual Gamepad on Boot 37 | 38 | ``` 39 | sudo npm install pm2 -g 40 | sudo pm2 start main.js 41 | sudo pm2 startup 42 | sudo pm2 save 43 | ``` 44 | 45 | In this way every time you turn your raspberry on an http server will show up in port 80. 46 | Be sure to have your smartphone in the same network as the raspberry 47 | 48 | After all this mess you will realize 2 things: 49 | - **it's working!** but the inputs are sensitive to the **network delay**, therefore you cannot really play the games which requires fast interactions :unamused: 50 | - i suggest you to buy a controller with usb. [link](https://www.androidcentral.com/best-raspberry-pi-controller) 51 | 52 | ### EmulationStation Controller Config: 53 | 54 | **/opt/retropie/configs/all/retroarch-joypads/Virtualgamepad.cfg** 55 | 56 | ``` ini 57 | input_device = "Virtual gamepad" 58 | input_driver = "udev" 59 | input_r_btn = "5" 60 | input_save_state_btn = "5" 61 | input_start_btn = "7" 62 | input_exit_emulator_btn = "7" 63 | input_l_btn = "4" 64 | input_load_state_btn = "4" 65 | input_up_axis = "-1" 66 | input_a_btn = "0" 67 | input_b_btn = "1" 68 | input_reset_btn = "1" 69 | input_down_axis = "+1" 70 | input_right_axis = "+0" 71 | input_state_slot_increase_axis = "+0" 72 | input_x_btn = "2" 73 | input_menu_toggle_btn = "2" 74 | input_select_btn = "6" 75 | input_enable_hotkey_btn = "6" 76 | input_y_btn = "3" 77 | input_left_axis = "-0" 78 | input_state_slot_decrease_axis = "-0" 79 | ``` 80 | -------------------------------------------------------------------------------- /docs/ScummVM.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![scummvm](https://cloud.githubusercontent.com/assets/10035308/12214107/156e1d4a-b645-11e5-886c-a49712b1a312.png) 3 | *** 4 | _ScummVM stands for Script Creation Utility for Maniac Mansion (VM stands for virtual machine). ScummVM is a program which allows you to run certain classic graphical point-and-click adventure games, provided you already have their data files_ 5 | *** 6 | 7 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 8 | | :---: | :---: | :---: | :---: | :---: | 9 | | [ScummVM](http://scummvm.org/) | scummvm | see below | none | hardcoded | 10 | 11 | ## Emulator: [ScummVM](http://scummvm.org/) 12 | 13 | ### ROMs 14 | 15 | Accepted File Extensions: This is a tricky question as ScummVM has its own particular filesets and method of loading- but when all is said and done **.sh .svm** are the filetypes EmulationStation will read. 16 | 17 | ScummVM is very different to most romsets in that there are a set of files for each game. 18 | 19 | See the list here: http://wiki.scummvm.org/index.php/Datafiles 20 | 21 | Place your folders of game files in: 22 | 23 | ``` 24 | /home/pi/RetroPie/roms/scummvm 25 | ``` 26 | 27 | ### List ScummVM games in EmulationStation 28 | 29 | Place an `.svm` file in the ROM folder for each game which you want to appear in EmulationStation. 30 | 31 | The `.svm` file contains the short name of the game. This can be used to directly launch that game without starting the ScummVM GUI first. 32 | 33 | The list of short names is at: https://www.scummvm.org/compatibility 34 | 35 | The [Recalbox documentation](https://www.lakka.tv/doc/ScummVM/) uses `.scummvm` files instead of `.svm` files. 36 | 37 | ### Example 38 | 39 | The game **Day of the Tentacle** has the shortname `tentacle` and requires files: 40 | 41 | * `MONSTER.SOU` 42 | * `TENTACLE.000` 43 | * `TENTACLE.001` 44 | 45 | Create a directory `/home/pi/RetroPie/roms/scummvm/Day of the Tentacle` and place the game files in it. 46 | 47 | Create a launcher file with the same name as the directory: `/home/pi/RetroPie/roms/scummvm/Day of the Tentacle/Day of the Tentacle.svm` 48 | 49 | This launcher file `Day of the Tentacle.svm` contains the shortname `tentacle` 50 | 51 | You can create the launcher file like: 52 | 53 | ``` 54 | echo "tentacle" > "/home/pi/RetroPie/roms/scummvm/Day of the Tentacle/Day of the Tentacle.svm" 55 | ``` 56 | 57 | The final file layout is: 58 | 59 | ``` 60 | /home/pi/RetroPie/roms/scummvm/Day of the Tentacle/Day of the Tentacle.svm 61 | /home/pi/RetroPie/roms/scummvm/Day of the Tentacle/MONSTER.SOU 62 | /home/pi/RetroPie/roms/scummvm/Day of the Tentacle/TENTACLE.000 63 | /home/pi/RetroPie/roms/scummvm/Day of the Tentacle/TENTACLE.001 64 | ``` 65 | 66 | Restarting EmulationStation will show the name **Day of the Tentacle** which is used to launch the game. 67 | 68 | ### Quick Start 69 | 70 | - Quit running rom without saving : Alt + X or Alt + Q 71 | 72 | - After you've added files to the scummvm rom folder, open up the +LAUNCH GUI 73 | 74 | - then hold down _shift_ and click "Mass Add..." 75 | 76 | - Navigate to the scummvm folder and select it to add all of your files 77 | 78 | - quit out of the GUI 79 | 80 | - Press F4 to get out of emulationstation 81 | 82 | - Type `emulationstation` to re-launch emulationstation 83 | 84 | - navigate to scummvm and your games will be there on the list and you'll have no need for a GUI 85 | 86 | 87 | ## Troubleshooting 88 | 89 | #### FUZZY MENU? 90 | 91 | You can open the **options** in the scummvm launcher and change the graphics mode to **opengl** and it will make the menu and your games clear and crisp! There are also other rendering modes as well that can be changed. 92 | 93 | 94 | ## Video Tutorial: 95 | 96 | 97 | -------------------------------------------------------------------------------- /docs/MESS.md: -------------------------------------------------------------------------------- 1 | 2 | *** 3 | ![](http://www.progettosnaps.net/mess/index_files/projectMESS.png) 4 | 5 | *** 6 | _MESS (Multi Emulator Super System) is a system that emulates a vast quantity of obscure hardware. It was merged with MAME in version .162._ 7 | *** 8 | 9 | ### Emulator: [lr-mess](https://github.com/libretro/MAME.git) 10 | 11 | ### ROMS: 12 | 13 | Using lr-mess in the way I am telling you here will only work with MAME Software List ROMs matching the version of MAME you are compiling. Any other set of ROMs will not work. A good guideline for avoiding bad ROMs: If you are downloading them through HTTP from a public ROM site, they are not likely to work. The ROMs cannot be unzipped or renamed. 14 | 15 | For more information on types of romsets see [HERE](https://www.reddit.com/r/MAME/comments/3wf6f0/question_what_is_the_difference_among_mame_roms/cxvt6av) 16 | 17 | ### System support 18 | 19 | At this point, the lr-mess script will automatically set up lr-mess for you only for systems that are known to run well on a Pi 2 with an overclock. If the system is not listed in the lr-mess script, it either has not been tested or has been tested and ran at a bad speed. 20 | 21 | Systems that have been tested and run well with lr-mess so far: 22 | 23 | * Colecovision (100% speed, driver: coleco) 24 | * CreatiVision (80-100% speed, driver: crvision, not added to the script yet) 25 | * Emerson Arcadia 2001 (100% speed, driver: arcadia) 26 | * Nintendo Entertainment System (100% speed, driver: nes) 27 | * Nintendo Gameboy (100% speed, driver: gameboy) 28 | * Sega Dreamcast VMU (100% speed, driver: svmu) 29 | 30 | Systems that have been tested and don’t run as well with lr-mess so far: 31 | 32 | * Amstrad GX4000 (65% speed, some games still feel very playable, driver: gx4000) 33 | * Atari 2600 (70-85% speed, driver: a2600) 34 | * Atari 5200 (50-60% speed, driver: a5200) 35 | * BBC Micro B (25% speed, driver: bbcb) 36 | * Intellivision (Fails to find/load saa5050 ROM, driver: intv) 37 | * Nintendo Gameboy Advance (50% speed, driver: gba 38 | * Sega Game Gear (80% speed, driver: gamegear) 39 | * Sega Genesis (46% speed, driver: megadriv) 40 | * Sharp X68000 (14% speed, driver: x68000) 41 | * SNK Neo Geo AES (60-65% speed, driver: aes) 42 | 43 | All systems other than those listed above have not been tested. 44 | 45 | ### Instructions 46 | 47 | Run the `lr-mess` script from the experimental menu. Compile should take about 3 hours on a Pi 2. 48 | 49 | Check your BIOS folder after compilation and see if a folder named "mame" exists. Within it should be a folder named "hash" that includes a bunch of xml files. These are the software lists that lr-mess requires. If they exist, we likely compiled properly. 50 | 51 | Go to your roms directory, wherever you have it (default: `/home/pi/RetroPie/roms/`) and create a directory named after the driver you wish to use. Place the BIOS file for that driver in the root of your roms directory. 52 | 53 | For example, if you wanted to run the Donkey Kong Colecovision rom (dkong.zip) through lr-mess, you would place your files like this: 54 | ```` 55 | /home/pi/RetroPie/roms: Main rom directory 56 | | 57 | +- coleco.zip: Coleco Driver BIOS zip (/home/pi/RetroPie/roms/coleco.zip) 58 | | 59 | +- /home/pi/RetroPie/roms/coleco 60 | | 61 | +- dkong.zip (/home/pi/RetroPie/roms/coleco/dkong.zip) 62 | ```` 63 | 64 | If the driver you wish to use does not require a ROM, you do not need to put one into your roms directory. 65 | 66 | Make sure **Core Options** for **MAME CLI Launching**, **MAME software lists** and **MAME auto media type** are enabled. See [Setting Core Options](RetroArch-Core-Options#setting-core-options). 67 | 68 | You may need to add .zip and .ZIP to your extensions in `/etc/emulationstation/es_systems.cfg` and restart emulationstation for it to pick up your ROMs. 69 | 70 | If all goes well, you should get the game running when you select it from emulationstation. If it quits back to emulationstation immediately, you likely have bad ROMs or something else unexpected happened. -------------------------------------------------------------------------------- /docs/Thomson-MOTO.md: -------------------------------------------------------------------------------- 1 | # Thomson MO/TO 2 | 3 | Thomson MO/TO Logo 4 | 5 | [Thomson MO/TO](https://en.wikipedia.org/wiki/Thomson_computers) is a family of 8-bit home computers produced by French company Thomson SA between 1982 and 1989. 6 | 7 | | Emulator | Rom Folder | Extension | BIOS | 8 | | :---: | :---: | :---: | :---: | 9 | | [lr-theodore](https://github.com/Zlika/theodore) | moto | .fd .sap .k7 .m5 .m7 .rom | - | 10 | 11 | ## Emulator: [lr-theodore](https://github.com/Zlika/theodore) 12 | 13 | **lr-theodore** is a libretro core for emulation of Thomson computers. It is based on Daniel Coulom's [DCTO8D](http://dcto8.free.fr/), [DCTO9P](http://dcto9p.free.fr/) and [DCMO5](http://dcmo5.free.fr/) emulators, and supports the following models: TO7, TO7/70, TO8, TO8D, TO9, TO9+, MO5, MO6 and also the [Olivetti Prodest PC128](https://it.wikipedia.org/wiki/Olivetti_Prodest_PC_128) (a rebranded MO6 for the Italian market). 14 | 15 | ## ROMS 16 | 17 | Accepted File Extensions: 18 | 19 | * **.fd** and **.sap** (floppy disks) 20 | * **.k7** (tapes) 21 | * **.m5**/**.m7** and **.rom** (cartridges). 22 | 23 | Place your MO/TO roms in 24 | ``` 25 | /home/pi/RetroPie/roms/moto 26 | ``` 27 | 28 | ## BIOS 29 | No BIOS file/rom is necessary. 30 | 31 | ## Controls 32 | 33 | `lr-theodore` uses the standard Retroarch input configuration, with the addition of a virtual keyboard when a keyboard is not present. 34 | 35 | ### Gamepad 36 | 37 | | Button | Action | 38 | | :---: | :---: | 39 | | B | _Fire_ button | 40 | | Start | _Start Program_ 41 | 42 | _Start Program_ simulates one or several keystrokes on the keyboard to start a game. This feature allows to start most games without the need for a keyboard. The key depends on the loaded media and of the current computer emulated. 43 | 44 | | Media loaded | Thomson computer | Key | 45 | | ------------: | ---------------- | ------------------- | 46 | | **Floppy disk** | TO8/TO8D/TO9+ | `B` key (BASIC 512) | 47 | | | TO9 | `D` key (BASIC 128) | 48 | | | MO5 | `RUN` + `Enter` | 49 | | **Tape** | TO8/TO8D/TO9+ | `C`key (BASIC 1.0) | 50 | | | TO9 | `E` key (BASIC 1.0) | 51 | | | MO5/MO6/TO7 | `RUN` or `LOADM"",,R` + `Enter` | 52 | | **Cartridge** | All but MO5/TO7 | `0` key | 53 | | | TO7/TO7-70 | `1` key | 54 | | | MO5 | Nothing (cartridges are already autostarted on MO5) 55 | 56 | 57 | ### Keyboard 58 | 59 | **Virtual keyboard** Use the `Select` button to show/hide the virtual keyboard. The transparency level of the virtual keyboard can be set in the core's options. 60 | 61 | When the virtual keyboard is displayed, the following buttons on the gamepad can be used: 62 | 63 | | RetroPad Button | Action | 64 | | ------------: | :---------------- | 65 | | `Right/Left/Up/Down` | Change focused key on the keyboard | 66 | | `B` | Press the focused key | 67 | | `B` (long press) | Make the key "sticky" (or release it if it was already sticky).
Up to 3 keys can be made sticky.
All sticky keys are released when the virtual keyboard is hidden.| 68 | |`Start` | Shortcut to press the "Enter" key | 69 | | `Y` | Move the keyboard in the upper or lower part of the screen | 70 | 71 | Mapping of the special MO/TO keys to a PC keyboard 72 | 73 | | Thomson keyboard | PC keyboard | 74 | | ------------- | ------------- | 75 | | STOP | TAB | 76 | | CNT | CTRL | 77 | | CAPSLOCK | CAPSLOCK | 78 | | ACC | BACKSPACE | 79 | | HOME | HOME | 80 | | Arrows | Arrows | 81 | | INS | INSERT | 82 | | EFF | DEL | 83 | | RAZ | ALT | 84 | | F1-F5 | F1-F5 | 85 | | F6-F10 | SHIFT+F1-F5 | 86 | | Yellow key (MO5) | Left SHIFT | 87 | | BASIC (MO5/MO6) | Right SHIFT | 88 | 89 | 90 | ### Lightpen 91 | 92 | The computer's light pen inputs are mapped to the mouse inputs. 93 | -------------------------------------------------------------------------------- /docs/PC-9800.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![pc98](https://user-images.githubusercontent.com/22881403/40662783-f0fd7244-631c-11e8-85f4-e814a9be0350.png) 3 | *** 4 | _The PC-9800 was a series of computers sold between 1982 and 2000 by NEC. The line ended up dominating the Japanese computer gaming market, with over 18 million units sold by the end of it's life._ 5 | *** 6 | 7 | | Emulator | Rom Folder | Extension | BIOS Files | 8 | | :---: | :---: | :---: | :---: | 9 | | [lr-np2kai](http://domisan.sakura.ne.jp/article/np2kai/np2kai.html) | pc98 | .d88 .d98 .88d .98d .fdi .xdf .hdm .dup .2hd .tfd .hdi .thd .nhd .hdd .fdd .cmd .hdn .zip| bios.rom, font.rom, itf.rom, sound.rom, 2608_bd.wav, 2608_sd.wav, 2608_top.wav, 2608_hh.wav, 2608_tom.wav, 2608_rim.wav | 10 | 11 | ## Emulator: [lr-np2kai](https://github.com/AZO234/NP2kai) 12 | This emulator can be installed from the experimental menu of the [RetroPie-Setup script.](Updating-RetroPie#using-the-retropie-setup-script) 13 | 14 | Libreto Docs for Neko Project II Kai are [HERE](https://docs.libretro.com/library/neko_project_ii_kai/) 15 | 16 | ## ROMS 17 | 18 | Accepted File Extensions: **.d88 .d98 .88d .98d .fdi .xdf .hdm .dup .2hd .tfd .hdi .thd .nhd .hdd .fdd .cmd .hdn .zip** 19 | 20 | Place your PC-98 games in: 21 | ``` 22 | /home/pi/RetroPie/roms/pc98 23 | ``` 24 | 25 | ## Multi Disk Games 26 | 27 | Many PC-98 games can be played as Hard Drive installs (`.hdi`), but many games are run from multiple floppies. To load two disks simultaneously into the emulator, you need to use a `.cmd` file, rather than a `.m3u` file. 28 | For example, _Story of Melroon_ has a Disk A and Disk B, so create a file named _The Story of Melroon.cmd_ containing: 29 | 30 | ``` 31 | np2kai "The Story of Melroon (Disk A).nfd" "The Story of Melroon (Disk B).nfd" 32 | ``` 33 | Starting the game from the `.cmd` file will load the _Disk A_ into the _FDD1_ disk drive and _Disk B_ into the _FDD2_ drive. Changing the disk in _FDD2_ can be done through RetroArch's disk control menus. The core will swap the contents of the _FDD2_ drive by default when using the disk control menus, to swap the disk in _FDD1_ there a core option which needs to be changed (_'Swap Disks on Drive'_). 34 | 35 | Some floppy disk images need to be writeable, as save data needs to be written to it. If they're not alreay writeable, run from the terminal the following command to change them is: 36 | 37 | ``` sh 38 | chmod u+w /path/to/your/disk_image_file 39 | ``` 40 | 41 | 42 | For example, based on the game mentioned before, changing the save disk's image file to be writeable would be: 43 | ``` sh 44 | chmod u+w "$HOME/RetroPie/roms/pc98/Dead of the Brain 2(Save Disk).hdm" 45 | ``` 46 | 47 | ## BIOS 48 | 49 | Place your BIOS files in: 50 | ``` 51 | /home/pi/RetroPie/BIOS/np2kai 52 | ``` 53 | 54 | ## BIOS files 55 | 56 | | File | md5sum | CRC32 | 57 | | :--: | :--: | :--: | 58 | | 2608_BD.WAV | 29AAD51CD243C8E449D311D14613F0B1 | FCB60C01 | 59 | | 2608_HH.WAV | 59A009EE444318BD57D99A19068731E4 | 7D6D9C4E | 60 | | 2608_RIM.WAV | 943290D1C5C6AE6295BD02BE4411C7C0 | 8518A388 | 61 | | 2608_SD.WAV | C99156118789B6CBA662C864EBADC62E | C977FDB8 | 62 | | 2608_TOM.WAV | C321A6835B26AD125B2EB78BE56394A4 | 5E8AB475 | 63 | | 2608_TOP.WAV | 9E73FF2345236EBE72F7A937E477F0BD | CEFA9F76 | 64 | | BIOS.ROM | E246140DEC5124C5E404869A84CAEFCE | 76AFFD90 | 65 | | FONT.ROM | 2AF6179D7DE4893EA0B705C00E9A98D6 | CD6DFABE | 66 | | SOUND.ROM | CAF90F22197AED6F14C471C21E64658D | A21EF796 | 67 | | ITF.ROM | E9FC3890963B12CF15D0A2EEA5815B72 | 273E9E88 | 68 | 69 | ## Controls 70 | 71 | lr-np2kai utilise Retroarch configurations 72 | 73 | Add custom retroarch controls to the retroarch.cfg file in 74 | ```shell 75 | /opt/retropie/configs/pc98/retroarch.cfg 76 | ``` 77 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) 78 | 79 | ## Performance Tweaks 80 | 81 | The "CPU Clock Multiplier" option in the RetroArch options menu is fairly important when it comes to performance. Setting it too low might cause your game to run slower than intended, but setting it too high can cause stuttering and slow performance. It is recommended to use somewhere between a 4x and 8x multiplier. 82 | -------------------------------------------------------------------------------- /docs/Sam-Coupe.md: -------------------------------------------------------------------------------- 1 | 2 | *** 3 | 4 | ![samcoupe](https://cloud.githubusercontent.com/assets/10035308/14407343/6f8941b2-fe82-11e5-9c8a-df7d53f396c6.jpg) 5 | 6 | *** 7 | _The SAM Coupé was an 8 bit computer released in 1989._ 8 | 9 | *** 10 | 11 | 12 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 13 | | :---: | :---: | :---: | :---: | :---: | 14 | | [SimCoupe](http://www.simcoupe.org/) | samcoupe | .dsk .mgt .sbt .sad | none | keyboard /opt/retropie/configs/simcoupe/SimCoupe.cfg | 15 | 16 | ### Emulator: [SimCoupe](http://www.simcoupe.org/) 17 | 18 | ### ROMS 19 | 20 | Accepted File Extensions: **.dsk .mgt .sbt .sad** 21 | 22 | Place your SAM Coupé ROMs in: 23 | 24 | ``` 25 | /home/pi/RetroPie/roms/samcoupe 26 | ``` 27 | 28 | ### Controls: 29 | 30 | ``` 31 | KEYBOARD INPUT 32 | 33 | The default SAM keyboard mode allows letters, digits and symbols to be typed 34 | as normal on your keyboard, with SimCoupe automatically converting them to the 35 | appropriate SAM key sequence. There's also a Spectrum mapping mode to use when 36 | running Spectrum software, and a raw mode to disable the mappings. 37 | 38 | The SAM has a keypad of function keys from F0 to F9 located on the right-side 39 | of the keyboard. For similar key positions in SimCoupe, the SAM keypad is 40 | mapped to the numeric keypad on your keyboard. You'll need to have Numlock 41 | enabled for these keys to be recognised. Don't forget that when SAM software 42 | refers to function keys, you must use the numeric keypad instead! 43 | 44 | F1 to F12 keys on your keyboard are used for emulator functions, with the 45 | default mappings shown below. Under OS X, keys F9 to F12 are used by Expose 46 | and Dashboard, so you'll need to hold the Command key in addition to the 47 | combinations below to access them. 48 | 49 | F1 = Open disk 1 50 | Shift-F1 = Eject disk 1 51 | Ctrl-F1 = Save disk 1 52 | Alt-F1 = New disk 1 53 | F2 = Open disk 2 54 | Shift-F2 = Eject disk 2 55 | Ctrl-F2 = Save disk 2 56 | Alt-F2 = New disk 2 57 | F3 = Tape browser 58 | F4 = Import data 59 | Shift-F4 = Export data 60 | Alt-F4 = Exit application 61 | F5 = Toggle 5:4 display 62 | F6 = Toggle display smoothing 63 | F7 = Toggle CRT scanlines 64 | Shift-F7 = Toggle hi-res scanlines 65 | F8 = Toggle full-screen 66 | F9 = Debugger 67 | Shift-F9 = Save screenshot 68 | F10 = Options 69 | F11 = NMI Button 70 | F12 = Reset button 71 | Ctrl-F12 = Exit application 72 | 73 | PrintScrn = Save SAM screenshot in PNG format 74 | Pause = Pause emulation 75 | Scroll Lock = Pause emulation 76 | Ctrl-Break = Reset 77 | Ctrl-Keypad * = Reset 78 | Ctrl-Keypad - = Normal emulation speed 79 | Keypad - = Reduce emulation speed 80 | Keypad + = Increase emulation speed 81 | Keypad * = Turbo speed 82 | 83 | Turbo speed disables the frame sync and sound, and limits the display to just 84 | 5 frames per second. This usually gives a big speed boost, which is useful for 85 | zooming through slow sections in games and demos, etc. 86 | 87 | 88 | SAM shift modifier keys and special symbols are mapped as follows: 89 | 90 | Insert = Inv 91 | Left-Ctrl = Symbol 92 | Right-Ctrl = Cntrl 93 | Left-Alt = Cntrl (if enabled) 94 | Right-Alt = Edit (if enabled) 95 | Menu Key = Edit 96 | ` (backtick) = (c) 97 | . (on keypad) = (c) 98 | § (section) = # 99 | 100 | The following additional combinations are also provided for convenience, since 101 | they map common keys to the equivalent function on the SAM: 102 | 103 | Native key SAM key 104 | ---------- ------- 105 | Delete = Shift-Delete 106 | Numlock = Symbol-Edit (toggles SAM BASIC keypad mode) 107 | Home = Cntrl-Left 108 | End = Cntrl-Right 109 | Page Up = F4 110 | Page Down = F1 111 | 112 | 113 | * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 114 | ``` -------------------------------------------------------------------------------- /docs/ZX-Spectrum.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![zx_spectrum](https://cloud.githubusercontent.com/assets/10035308/12212920/3dc40236-b62d-11e5-8ee4-c224358c1424.png) 3 | *** 4 | _The ZX Spectrum was an 8 bit series of home computers released by Sinclair Research in 1982._ 5 | 6 | *** 7 | 8 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 9 | | :---: | :---: | :---: | :---: | :---: | 10 | | [lr-fuse](https://github.com/libretro/fuse-libretro) | zxspectrum | .sna .szx .z80 .tap .tzx .gz .udi .mgt .img .trd .scl .dsk | none | /opt/retropie/configs/zxspectrum/retroarch.cfg | 11 | | [FBZX](http://www.rastersoft.com/programas/fbzx.html) | zxspectrum | .sna .szx .z80 .tap .tzx .gz .udi .mgt .img .trd .scl .dsk | none | hardcoded | 12 | | [Fuse](http://fuse-emulator.sourceforge.net/) | zxspectrum | .sna .szx .z80 .tap .tzx .gz .udi .mgt .img .trd .scl .dsk | none | hardcoded | 13 | | [ZEsarUX](https://github.com/chernandezba/zesarux/) | zxspectrum | .sna .szx .z80 .tap .tzx .gz .udi .mgt .img .trd .scl .dsk | none | configurable | 14 | 15 | ## Emulators: [lr-fuse](https://github.com/libretro/fuse-libretro), [FBZX](http://www.rastersoft.com/programas/fbzx.html), [Fuse](http://fuse-emulator.sourceforge.net/) 16 | 17 | ## ROMS 18 | 19 | Accepted File Extensions: **sna .szx .z80 .tap .tzx .gz .udi .mgt .img .trd .scl .dsk** 20 | 21 | Place your ZX Spectrum ROMs in 22 | ``` 23 | /home/pi/RetroPie/roms/zxspectrum 24 | ``` 25 | 26 | ## Video Overview: 27 | [![ZX Spectrum Video](http://img.youtube.com/vi/_Rs20bAy-sY/0.jpg)](http://www.youtube.com/watch?v=_Rs20bAy-sY) 28 | 29 | ## Controls 30 | 31 | ### lr-fuse 32 | 33 | lr-fuse utilises Retroarch configurations 34 | 35 | Add custom retroarch controls to the retroarch.cfg file in 36 | ```shell 37 | /opt/retropie/configs/zxspectrum/retroarch.cfg 38 | ``` 39 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) 40 | 41 | By default, 42 | 43 | * Buttons A, X and Y are mapped to the joystick's fire button, and button B is mapped to the UP directional button. 44 | * Buttons L1 and R1 are mapped to RETURN and SPACE, respectively. 45 | * The SELECT button brings up the embedded, on-screen keyboard. 46 | 47 | If you are using more than one joystick, then it is worth reading the [official documentation](https://github.com/libretro/fuse-libretro#input-devices) at lr-fuse Github page. 48 | 49 | The default joystick emulated by lr-fuse is the Cursor joystick. If you wish to set Kempston as your default, then add the following line to the file `/opt/retropie/configs/all/zxspectrum/retroarch.cfg`: 50 | 51 | input_libretro_device_p1 = "513" 52 | 53 | ### Running a 48K Machine 54 | 55 | Some ZX Spectrum games require a 16K machine (e.g. Deathchase) or will run only on a 48K machine, for example, titles from Ultimate Play The Game such as Atic Atac and Jetpac. 56 | 57 | By default, lr-fuse emulates the 128K machine but it is possible to emulate a given ROM in a 48K machine via loading the ROM, changing the **Core Option** per-ROM for **Model (needs Content file)** to **48k** (see [Setting Core Options per-ROM](RetroArch-Core-Options#setting-core-options-per-rom)), then exiting and re-loading the ROM. 58 | 59 | ### Joypad to Keyboard Mapping 60 | Thanks to forum member @pjft's [contribution](https://retropie.org.uk/forum/topic/16753/lr-fuse-joypad-to-keyboard-mapping) to lr-fuse, it is possible to play ZX Spectrum games without a need for a keyboard. This is useful for games that don't support joysticks such as Chuckie Egg and for games that require keyboard input in addition to a joystick (e.g. Head Over Heels). 61 | 62 | 1. Launch a game you wish to map a joypad to a keyboard. 63 | 2. Launch the RGUI by pressing hotkey+X and navigate to `Quick menu` -> `Options`. In the menu, assign a key to joypad buttons `Joypad Left mapping`, `Joypad Right mapping` etc. as required. Below is an example for Chuckie Egg. 64 | 65 | ![RetroArch Options menu for Chuckie Egg](https://user-images.githubusercontent.com/8166945/51169479-e7405680-18a3-11e9-99ac-131838813999.png) 66 | 67 | 3. Exit the RGUI and test in-game if necessary. 68 | 4. To save, return to `Quick menu` -> `Options` in the RGUI and select `Game-options file`. This will save the mappings to a game specific options file. 69 | 70 | -------------------------------------------------------------------------------- /docs/Saturn.md: -------------------------------------------------------------------------------- 1 | *** 2 | ![saturn_long](https://cloud.githubusercontent.com/assets/10035308/12213706/78d47d62-b63a-11e5-9128-8ba89e6f8950.png) 3 | *** 4 | _The Sega Saturn is a 32 bit 5th generation home video game console released by Sega in 1994. It has a total of 8 processors which makes it one of the most difficult consoles to emulate._ 5 | *** 6 | 7 | | Emulator | Rom Folder | Extension | BIOS | Controller Config | 8 | | :---: | :---: | :---: | :---: | :---: | 9 | | [lr-yabause](https://github.com/libretro/yabause) | saturn | .bin .cue .iso .mdf | saturn_bios.bin | /opt/retropie/configs/saturn/retroarch.cfg | 10 | |[lr-beetle-saturn](https://github.com/libretro/beetle-saturn-libretro)| saturn | .bin .cue .iso .mdf | sega_101.bin, mpr-17933.bin | /opt/retropie/configs/saturn/retroarch.cfg 11 | 12 | ## Emulators: [lr-yabause](https://github.com/libretro/yabause), [lr-beetle-saturn](https://github.com/libretro/beetle-saturn-libretro) 13 | 14 | **lr-yabause** is experimental, and even with an overclocked RPi4B it is slow so it isn't recommended for Raspberry Pi users at this time. 15 | 16 | **lr-beetle-saturn** is for x86 PCs only, and is recommended for those with such hardware. 17 | 18 | ## ROMS 19 | 20 | Accepted File Extensions: **.cue .bin .iso .mdf** 21 | 22 | Place your Sega Saturn ROMs in 23 | 24 | ``` 25 | /home/pi/RetroPie/roms/saturn 26 | ``` 27 | 28 | ### Why don't my .bin or .iso files show up? 29 | 30 | RetroPie is configured to only show .cue files in EmulationStation so that you do not have two copies showing up of all your games. 31 | 32 | A .cue file is basically a plain text file that tells the emulator where in the .bin file the (data and/or audio) track(s) are. This is often important in the case where multiple audio files are in the single .bin file. These are often called "mixed mode" discs. [Wikipedia .cue files](https://en.wikipedia.org/wiki/Cue_sheet_(computing)) 33 | 34 | If you only have a .bin file and no .cue file, you can generate it: 35 | 36 | - [Manually](http://www.shivaranjan.com/2007/01/03/how-to-create-cue-file-for-a-bin-file-in-5-steps/) 37 | - [Individually](http://www.dslreports.com/r0/download/373724~1e45059000cfc371c157f544cc5aef07/MakeCue.zip) 38 | - [En masse or individually](https://github.com/thorst/CueMaker) 39 | 40 | a few more notes on cue sheets [HERE](https://github.com/libretro/beetle-saturn-libretro#loading-isos) 41 | 42 | ## BIOS 43 | 44 | The BIOS file needed for lr-yabause is **saturn_bios.bin** or for lr-beetle-saturn **sega_101.bin** (Required for JP games) and **mpr-17933.bin** (Required for US/EU games) 45 | 46 | Place your BIOS in 47 | 48 | ``` 49 | /home/pi/RetroPie/BIOS 50 | ``` 51 | 52 | **BIOS files** 53 | 54 | | File | md5sum | CRC32 | 55 | |------|--------|-------| 56 | | saturn_bios.bin | af5828fdff51384f99b3c4926be27762 | 2aba43c2 | 57 | | sega_101.bin | 85ec9ca47d8f6807718151cbcca8b964 | 224b752c | 58 | | mpr-17933.bin | 3240872C70984B6CBFDA1586CAB68DBE | 4AFCF0FA | 59 | 60 | ## Controls 61 | 62 | lr-yabause and lr-beetle-saturn utilise Retroarch configurations 63 | 64 | Add custom retroarch controls to the retroarch.cfg file in 65 | ```shell 66 | /opt/retropie/configs/saturn/retroarch.cfg 67 | ``` 68 | For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration) 69 | 70 | ![sega_saturn_diagram](https://cloud.githubusercontent.com/assets/10035308/16599639/7f42ac24-42c0-11e6-8978-5f3cce723393.png) 71 | 72 | ## Standalone 73 | 74 | The standalone version runs faster but requires X, QT, etc. Even then, it manages 10FPS so probably not worth adding to the scripts. If you're curious, here's the basic instructions to get it installed: 75 | ``` 76 | sudo apt update 77 | sudo apt install xinit qt4-dev-tools build-essential libgl1-mesa-dev 78 | ``` 79 | make some directory, and go in it 80 | 81 | ``` 82 | mkdir tempdev 83 | cd tempdev 84 | ``` 85 | 86 | ``` 87 | git clone https://github.com/Yabause/yabause.git 88 | 89 | cd yabause/yabause/src 90 | 91 | cmake -DYAB_WANT_OPENGL=NO $SOURCES 92 | 93 | make 94 | ``` 95 | 96 | go into a terminal on your pi itself 97 | 98 | navigate to /your_directory/yabause/yabausesrc/qt 99 | 100 | ``` 101 | sudo xinit ./yabause 102 | ``` 103 | --------------------------------------------------------------------------------